001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math4.optim.nonlinear.scalar;
018
019import org.apache.commons.math4.exception.NotStrictlyPositiveException;
020import org.apache.commons.math4.optim.OptimizationData;
021
022/**
023 * Population size.
024 *
025 * Input data for optimization algorithms whose global search strategy
026 * relies on multiple simultaneous candidate solutions.
027 */
028public class PopulationSize implements OptimizationData {
029    /** Population size. */
030    private final int size;
031
032    /**
033     * @param size Population size.
034     * @throws NotStrictlyPositiveException if {@code size <= 0}.
035     */
036    public PopulationSize(int size)
037        throws NotStrictlyPositiveException {
038        if (size <= 0) {
039            throw new NotStrictlyPositiveException(size);
040        }
041        this.size = size;
042    }
043
044    /**
045     * @return the population size.
046     */
047    public int getPopulationSize() {
048        return size;
049    }
050}