org.uncertml.distribution.multivariate.MultinomialDistribution.java Source code

Introduction

Here is the source code for org.uncertml.distribution.multivariate.MultinomialDistribution.java

Source

/**
 * Copyright 2014 52North Initiative for Geospatial Open Source Software GmbH
 *
 * Licensed 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.uncertml.distribution.multivariate;

import java.util.Arrays;
import java.util.List;
import org.apache.commons.lang.ArrayUtils;
import org.uncertml.util.Validate;

/**
 * Class representing a multinomial distribution with parameters number of trials
 * and probabilities.
 * 
 * {@URL https://wiki.aston.ac.uk/foswiki/bin/view/UncertWeb/Multinomial}
 * 
 * @author Matthew Williams
 * @version 2.0
 */
public class MultinomialDistribution implements IMultivariateDistribution {

    private int numberOfTrials;
    private List<Double> probabilities;

    /**
     * Constructor taking a single number of trials and an array of doubles for
     * the probabilities.
     * 
     * @param numberOfTrials the number of trials parameter.
     * @param probabilities an array of doubles representing the probabilities parameter.
     */
    public MultinomialDistribution(int numberOfTrials, double[] probabilities) {
        this(numberOfTrials, Arrays.asList(ArrayUtils.toObject(probabilities)));
    }

    /**
     * Constructor taking a single number of trials and a list of doubles for
     * the probabilities.
     * 
     * @param numberOfTrials the number of trials parameter.
     * @param probabilities a list of doubles representing the probabilities parameter.
     */
    public MultinomialDistribution(int numberOfTrials, List<Double> probabilities) {

        Validate.notNull(probabilities);
        Validate.allElementsBetween(probabilities, 0, 1);

        this.numberOfTrials = numberOfTrials;
        this.probabilities = probabilities;
    }

    /**
     * 
     * @return the number of trials parameter.
     */
    public int getNumberOfTrials() {
        return numberOfTrials;
    }

    /**
     * 
     * @return the probabilities parameter.
     */
    public List<Double> getProbabilities() {
        return probabilities;
    }
}