1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.math4.legacy.optim.nonlinear.scalar; 18 19 import org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException; 20 import org.apache.commons.math4.legacy.optim.OptimizationData; 21 22 /** 23 * Population size. 24 * 25 * Input data for optimization algorithms whose global search strategy 26 * relies on multiple simultaneous candidate solutions. 27 */ 28 public class PopulationSize implements OptimizationData { 29 /** Population size. */ 30 private final int size; 31 32 /** 33 * @param size Population size. 34 * @throws NotStrictlyPositiveException if {@code size <= 0}. 35 */ 36 public PopulationSize(int size) 37 throws NotStrictlyPositiveException { 38 if (size <= 0) { 39 throw new NotStrictlyPositiveException(size); 40 } 41 this.size = size; 42 } 43 44 /** 45 * @return the population size. 46 */ 47 public int getPopulationSize() { 48 return size; 49 } 50 }