org.uncertml.distribution.discrete.GeometricDistribution.java Source code

Introduction

Here is the source code for org.uncertml.distribution.discrete.GeometricDistribution.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.discrete;

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

import org.uncertml.util.Validate;

/**
 * Class representing a geometric distribution with probability parameter.
 * 
 * {@URL https://wiki.aston.ac.uk/foswiki/bin/view/UncertWeb/Geometric}
 * 
 * @author Matthew Williams
 * @version 2.0
 */
public class GeometricDistribution implements IDiscreteDistribution {

    private List<Double> probability;

    /**
     * Constructor that takes a single probability parameter.
     * 
     * @param probability the probability parameter.
     */
    public GeometricDistribution(double probability) {
        this(new double[] { probability });
    }

    /**
     * Constructor that takes an array of doubles for probability parameters. Each probability
     * represents a unique geometric distribution. This is in line with the 
     * UncertML syntax whereby a collection of types can be represented by a single
     * entity.
     * 
     * @param probability an array of doubles representing the probability parameter of n
     * geometric distributions.
     */
    public GeometricDistribution(double[] probability) {
        this(Arrays.asList(ArrayUtils.toObject(probability)));
    }

    /**
     * Constructor that takes a list of doubles for probability parameters. Each probability
     * represents a unique geometric distribution. This is in line with the 
     * UncertML syntax whereby a collection of types can be represented by a single
     * entity. The list must not contain any null elements.
     * 
     * @param probability a list of doubles representing the probability parameter of n
     * geometric distributions.
     */
    public GeometricDistribution(List<Double> probability) {
        Validate.notNull(probability);
        Validate.noNullElements(probability);
        Validate.allElementsBetween(probability, 0, 1);
        this.probability = new ArrayList<Double>(probability);
    }

    /**
     * 
     * @return the probability parameter of each geometric distribution represented
     * by this object.
     */
    public List<Double> getProbability() {
        return probability;
    }

}