package jsat.lossfunctions;

import java.io.Serializable;

/**
 * Provides a generic interface for some loss function on some problem that can
 * be described with a single real prediction value and a single real expected
 * value.
 * 

* A loss function must be non-negative and should be convex. * * @author Edward Raff */ public interface LossFunc extends Serializable { /** * Computes the loss for some problem. * * @param pred the predicted value in (-Infinity, Infinity) * @param y the true value in (-Infinity, Infinity) * @return the loss in [0, Inf) */ public double getLoss(double pred, double y); /** * Computes the first derivative of the loss function. * * @param pred the predicted score in (-Infinity, Infinity) * @param y the true value in (-Infinity, Infinity) * @return the first derivative of the getLoss */ public double getDeriv(double pred, double y); /** * Computes the second derivative of the getLoss function. * * @param pred the predicted score in (-Infinity, Infinity) * @param y the true value in (-Infinity, Infinity) * @return the second derivative of the getLoss function */ public double getDeriv2(double pred, double y); /** * Computes the result of the conjugate function of this loss. This function * is generally optional, and should return {@link Double#NaN} if not * properly implemented. Many optimization algorithms do require a working * implementation though. * @param b the primary input to the function * @param pred the predicted score in (-Infinity, Infinity) * @param y the true class label in {-1, 1} * @return the result of the conjugate function of this loss */ public double getConjugate(double b, double pred, double y); /** * Returns an upper bound on the maximum value of the second derivative. If * the second derivative does not exist, {@link Double#NaN} is a valid * result. It is also possible for {@code 0} and * {@link Double#POSITIVE_INFINITY} to be valid results, and must be checked * for. * * @return the max value of {@link #getDeriv2(double, double) } */ public double getDeriv2Max(); /** * If this loss is L-Lipschitz (1/L Lipschitz smooth), this method will return the value of L. If it is not L-Lipschitz, a value of 0 will be returned. * @return the L-Lipschitz constant, or 0 if this loss is not L-Lipschitz; */ public double lipschitz(); public LossFunc clone(); }

Ads help maintain this website.