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

/**
 * Only for performance tuning of compute intensive linear algebraic
 * computations. Constructs functions that return one of
 * 

 * 
a * constant
 * 
a / constant
 * 
 * a is variable, constant is fixed, but for performance
 * reasons publicly accessible. Intended to be passed to
 * matrix.assign(function) methods.
 */
public final class FloatMult implements cern.colt.function.tfloat.FloatFunction {
    /**
     * Public read/write access to avoid frequent object construction.
     */
    public float multiplicator;

    /**
     * Insert the method's description here. Creation date: (8/10/99 19:12:09)
     */
    protected FloatMult(final float multiplicator) {
        this.multiplicator = multiplicator;
    }

    /**
     * Returns the result of the function evaluation.
     */
    public final float apply(float a) {
        return a * multiplicator;
    }

    /**
     * a / constant.
     */
    public static FloatMult div(final float constant) {
        return mult(1 / constant);
    }

    /**
     * a * constant.
     */
    public static FloatMult mult(final float constant) {
        return new FloatMult(constant);
    }
}