Package org.apache.commons.math3.optim.linear

Class LinearObjectiveFunction

  • All Implemented Interfaces:
    java.io.Serializable, MultivariateFunction, OptimizationData
    public class LinearObjectiveFunction
extends java.lang.Object
implements MultivariateFunction, OptimizationData, java.io.Serializable
    An objective function for a linear optimization problem.

    A linear objective function has one the form: 

     c1x1 + ... cnxn + d
    The ci and d are the coefficients of the equation, the xi are the coordinates of the current point.

    Since:
    2.0
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private RealVector coefficients
      Coefficients of the linear equation (ci).
      private double constantTerm
      Constant term of the linear equation.
      private static long serialVersionUID
      Serializable version identifier.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      RealVector getCoefficients()
      Gets the coefficients of the linear equation being optimized.
      double getConstantTerm()
      Gets the constant of the linear equation being optimized.
      int hashCode()
      private void readObject​(java.io.ObjectInputStream ois)
      Deserialize the instance.
      double value​(double[] point)
      Computes the value of the linear equation at the current point.
      double value​(RealVector point)
      Computes the value of the linear equation at the current point.
      private void writeObject​(java.io.ObjectOutputStream oos)
      Serialize the instance.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Serializable version identifier.
        See Also:
        Constant Field Values

      • coefficients

        private final transient RealVector coefficients
        Coefficients of the linear equation (ci).

      • constantTerm

        private final double constantTerm
        Constant term of the linear equation.

    • Constructor Detail

      • LinearObjectiveFunction

        public LinearObjectiveFunction​(double[] coefficients,
                               double constantTerm)
        Parameters:
        coefficients - Coefficients for the linear equation being optimized.
        constantTerm - Constant term of the linear equation.

      • LinearObjectiveFunction

        public LinearObjectiveFunction​(RealVector coefficients,
                               double constantTerm)
        Parameters:
        coefficients - Coefficients for the linear equation being optimized.
        constantTerm - Constant term of the linear equation.

    • Method Detail

      • getCoefficients

        public RealVector getCoefficients()
        Gets the coefficients of the linear equation being optimized.
        Returns:
        coefficients of the linear equation being optimized.

      • getConstantTerm

        public double getConstantTerm()
        Gets the constant of the linear equation being optimized.
        Returns:
        constant of the linear equation being optimized.

      • value

        public double value​(double[] point)
        Computes the value of the linear equation at the current point.
        Specified by:
        value in interface MultivariateFunction
        Parameters:
        point - Point at which linear equation must be evaluated.
        Returns:
        the value of the linear equation at the current point.

      • value

        public double value​(RealVector point)
        Computes the value of the linear equation at the current point.
        Parameters:
        point - Point at which linear equation must be evaluated.
        Returns:
        the value of the linear equation at the current point.

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • writeObject

        private void writeObject​(java.io.ObjectOutputStream oos)
                  throws java.io.IOException
        Serialize the instance.
        Parameters:
        oos - stream where object should be written
        Throws:
        java.io.IOException - if object cannot be written to stream

      • readObject

        private void readObject​(java.io.ObjectInputStream ois)
                 throws java.lang.ClassNotFoundException,
                        java.io.IOException
        Deserialize the instance.
        Parameters:
        ois - stream from which the object should be read
        Throws:
        java.lang.ClassNotFoundException - if a class in the stream cannot be found
        java.io.IOException - if object cannot be read from the stream