cern.colt.matrix.tobject.ObjectMatrix3DProcedure 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!

/*
Copyright (C) 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose 
is hereby granted without fee, provided that the above copyright notice appear in all copies and 
that both that copyright notice and this permission notice appear in supporting documentation. 
CERN makes no representations about the suitability of this software for any purpose. 
It is provided "as is" without expressed or implied warranty.
 */
package cern.colt.matrix.tobject;

import cern.colt.matrix.tdouble.DoubleMatrix3D;

/**
 * Interface that represents a condition or procedure object: takes a single
 * argument and returns a boolean value.
 */
public interface ObjectMatrix3DProcedure {
    /**
     * 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(DoubleMatrix3D element);

    /**
     * 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(ObjectMatrix3D element);
}