mathfuncs.java

SimMetrics is a Similarity Metric Library, e.g. from edit distance s (Levenshtein, Gotoh, Jaro etc)

/**
 * SimMetrics - SimMetrics is a java library of Similarity or Distance 
 * Metrics, e.g. Levenshtein Distance, that provide float based similarity
 * measures between String Data. All metrics return consistant measures 
 * rather than unbounded similarity scores.
 * 
 * Copyright (C) 2005 Sam Chapman - Open Source Release v1.1
 *
 * Please Feel free to contact me about this library, I would appreciate
 * knowing quickly what you wish to use it for and any criticisms/comments
 * upon the SimMetric library.
 *
 * email:       [e-mail]
 * www:         http://www.dcs.shef.ac.uk/~sam/
 * www:         http://www.dcs.shef.ac.uk/~sam/stringmetrics.html
 *
 * address:     Sam Chapman,
 *              Department of Computer Science,
 *              University of Sheffield,
 *              Sheffield,
 *              S. Yorks,
 *              S1 4DP
 *              United Kingdom,
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package uk.ac.shef.wit.simmetrics.math;

/**
 * Package: uk.ac.shef.wit.simmetrics.math
 * Description: MathFuncs implements a number of handy maths functions.
 * Date: 24-Mar-2004
 * Time: 14:15:30
 * @author Sam Chapman <a href="http://www.dcs.shef.ac.uk/~sam/">Website</a>, <a href="mailto:[e-mail]">Email</a>.
 * @version 1.1
 */
final public class MathFuncs {

    /**
     * returns the max of three numbers.
     *
     * @param x
     * @param y
     * @param z
     * @return the max of three numbers
     */
    public static float max3(final float x, final float y, final float z) {
        return Math.max(x, Math.max(y, z) );
    }

    /**
     * returns the max of four numbers.
     *
     * @param w
     * @param x
     * @param y
     * @param z
     * @return the max of four numbers
     */
    public static float max4(final float w, final float x, final float y, final float z) {
        return Math.max(Math.max(w, x), Math.max(y, z));
    }

    /**
     * returns the min of three numbers.
     *
     * @param x
     * @param y
     * @param z
     * @return the min of three numbers
     */
    public static float min3(final float x, final float y, final float z) {
        return Math.min(x, Math.min(y, z));
    }

    /**
     * returns the min of three numbers.
     *
     * @param x
     * @param y
     * @param z
     * @return the min of three numbers
     */
    public static int min3(final int x, final int y, final int z) {
        return Math.min(x, Math.min(y, z));
    }

    /**
     * returns the max of three numbers.
     *
     * @param x
     * @param y
     * @param z
     * @return the max of three numbers
     */
    public static int max3(final int x, final int y, final int z) {
        return Math.max(x, Math.max(y, z));
    }
}