cern.colt.function.tfcomplex.FComplexProcedure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parallelcolt Show documentation

Parallel Colt is a multithreaded version of Colt - a library for high performance scientific computing in Java. It contains efficient algorithms for data analysis, linear algebra, multi-dimensional arrays, Fourier transforms, statistics and histogramming.

The newest version!

package cern.colt.function.tfcomplex;

/**
 * Interface that represents a procedure object: a procedure that takes a single
 * argument and does not return a value.
 */
public interface FComplexProcedure {
    /**
     * Applies a procedure to an argument. Optionally can return a boolean flag
     * to inform the object calling the procedure.
     * 
     * 
     * Example: forEach() methods often use procedure objects. To signal to a
     * forEach() method whether iteration should continue normally or terminate
     * (because for example a matching element has been found), a procedure can
     * return false to indicate termination and true to
     * indicate continuation.
     * 
     * @param element
     *            element passed to the procedure.
     * @return a flag to inform the object calling the procedure.
     */
    abstract public boolean apply(float[] element);
}