diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.java | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.java b/src/main/java/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.java new file mode 100644 index 0000000..98e9348 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.java @@ -0,0 +1,68 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.math3.distribution; + +import org.apache.commons.math3.exception.NotStrictlyPositiveException; +import org.apache.commons.math3.exception.util.LocalizedFormats; +import org.apache.commons.math3.random.RandomGenerator; + +/** + * Base class for multivariate probability distributions. + * + * @since 3.1 + */ +public abstract class AbstractMultivariateRealDistribution implements MultivariateRealDistribution { + /** RNG instance used to generate samples from the distribution. */ + protected final RandomGenerator random; + + /** The number of dimensions or columns in the multivariate distribution. */ + private final int dimension; + + /** + * @param rng Random number generator. + * @param n Number of dimensions. + */ + protected AbstractMultivariateRealDistribution(RandomGenerator rng, int n) { + random = rng; + dimension = n; + } + + /** {@inheritDoc} */ + public void reseedRandomGenerator(long seed) { + random.setSeed(seed); + } + + /** {@inheritDoc} */ + public int getDimension() { + return dimension; + } + + /** {@inheritDoc} */ + public abstract double[] sample(); + + /** {@inheritDoc} */ + public double[][] sample(final int sampleSize) { + if (sampleSize <= 0) { + throw new NotStrictlyPositiveException(LocalizedFormats.NUMBER_OF_SAMPLES, sampleSize); + } + final double[][] out = new double[sampleSize][dimension]; + for (int i = 0; i < sampleSize; i++) { + out[i] = sample(); + } + return out; + } +} |