1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.rng.core;
18
19 import java.util.Arrays;
20
21 import org.apache.commons.rng.RandomProviderState;
22
23 /**
24 * Wraps the internal state of a generator instance.
25 * Its purpose is to store all the data needed to recover the same
26 * state in order to restart a sequence where it left off.
27 * External code should not try to modify the data contained in instances
28 * of this class.
29 *
30 * @since 1.0
31 */
32 public class RandomProviderDefaultState implements RandomProviderState {
33 /** Internal state. */
34 private final byte[] state;
35
36 /**
37 * Initializes an instance.
38 * The contents of the {@code state} argument is unspecified, and is
39 * guaranteed to be valid only if it was generated by implementations
40 * provided by this library.
41 *
42 * @param state Mapping of all the data which an implementation of
43 * {@link org.apache.commons.rng.UniformRandomProvider} needs in order
44 * to reset its internal state.
45 */
46 public RandomProviderDefaultState(byte[] state) {
47 this.state = Arrays.copyOf(state, state.length);
48 }
49
50 /**
51 * @return the internal state.
52 */
53 public byte[] getState() {
54 return Arrays.copyOf(state, state.length);
55 }
56 }