alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Commons Math example source code file (FixedGenerationCount.java)

This example Commons Math source code file (FixedGenerationCount.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Commons Math tags/keywords

fixedgenerationcount, fixedgenerationcount, illegalargumentexception, illegalargumentexception, stoppingcondition, stoppingcondition, the, the

The Commons Math FixedGenerationCount.java source code

/*
 * 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.math.genetics;

/**
 * Stops after a fixed number of generations.  Each time
 * {@link #isSatisfied(Population)} is invoked, a generation counter is
 * incremented.  Once the counter reaches the configured
 * <code>maxGenerations value, {@link #isSatisfied(Population)} returns
 * true.
 *
 * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $
 * @since 2.0
 */
public class FixedGenerationCount implements StoppingCondition {
    /** Number of generations that have passed */
    private int numGenerations = 0;

    /** Maximum number of generations (stopping criteria) */
    private final int maxGenerations;

    /**
     * Create a new FixedGenerationCount instance.
     *
     * @param maxGenerations number of generations to evolve
     */
    public FixedGenerationCount(int maxGenerations) {
        if (maxGenerations <= 0)
            throw new IllegalArgumentException("The number of generations has to be >= 0");
        this.maxGenerations = maxGenerations;
    }

    /**
     * Determine whether or not the given number of generations have passed.
     * Increments the number of generations counter if the maximum has not
     * been reached.
     *
     * @param population ignored (no impact on result)
     * @return <code>true IFF the maximum number of generations has been exceeded
     */
    public boolean isSatisfied(Population population) {
        if (this.numGenerations < this.maxGenerations) {
            numGenerations++;
            return false;
        }
        return true;
    }

    /**
     * @return the number of generations that have passed
     */
    public int getNumGenerations() {
        return numGenerations;
    }

}

Other Commons Math examples (source code examples)

Here is a short list of links related to this Commons Math FixedGenerationCount.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.