PopulationSize.java

/*
 * 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.math4.legacy.optim.nonlinear.scalar;

import org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException;
import org.apache.commons.math4.legacy.optim.OptimizationData;

/**
 * Population size.
 *
 * Input data for optimization algorithms whose global search strategy
 * relies on multiple simultaneous candidate solutions.
 */
public class PopulationSize implements OptimizationData {
    /** Population size. */
    private final int size;

    /**
     * @param size Population size.
     * @throws NotStrictlyPositiveException if {@code size <= 0}.
     */
    public PopulationSize(int size)
        throws NotStrictlyPositiveException {
        if (size <= 0) {
            throw new NotStrictlyPositiveException(size);
        }
        this.size = size;
    }

    /**
     * @return the population size.
     */
    public int getPopulationSize() {
        return size;
    }
}