org.apache.commons.math3.optimization.linear

## Class LinearObjectiveFunction

- java.lang.Object
- - org.apache.commons.math3.optimization.linear.LinearObjectiveFunction

- All Implemented Interfaces:
    Serializable

      public class LinearObjectiveFunction
      extends Object
      implements 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
  Version:
    $Id: LinearObjectiveFunction.java 1244107 2012-02-14 16:17:55Z erans $
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `LinearObjectiveFunction(double[] coefficients, double constantTerm)`
    `LinearObjectiveFunction(RealVector coefficients, double constantTerm)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object other)`
    `RealVector` | `getCoefficients()` Get the coefficients of the linear equation being optimized.
    `double` | `getConstantTerm()` Get the constant of the linear equation being optimized.
    `double` | `getValue(double[] point)` Compute the value of the linear equation at the current point
    `double` | `getValue(RealVector point)` Compute the value of the linear equation at the current point
    `int` | `hashCode()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### LinearObjectiveFunction

          public LinearObjectiveFunction(double[] coefficients,
                                 double constantTerm)

      Parameters:
        `coefficients` - The coefficients for the linear equation being optimized
        `constantTerm` - The constant term of the linear equation

    - #### LinearObjectiveFunction

          public LinearObjectiveFunction(RealVector coefficients,
                                 double constantTerm)

      Parameters:
        `coefficients` - The coefficients for the linear equation being optimized
        `constantTerm` - The constant term of the linear equation

  - ### Method Detail

    - #### getCoefficients

          public RealVector getCoefficients()

      Get the coefficients of the linear equation being optimized.
      Returns:
        coefficients of the linear equation being optimized

    - #### getConstantTerm

          public double getConstantTerm()

      Get the constant of the linear equation being optimized.
      Returns:
        constant of the linear equation being optimized

    - #### getValue

          public double getValue(double[] point)

      Compute the value of the linear equation at the current point
      Parameters:
        `point` - point at which linear equation must be evaluated
      Returns:
        value of the linear equation at the current point

    - #### getValue

          public double getValue(RealVector point)

      Compute the value of the linear equation at the current point
      Parameters:
        `point` - point at which linear equation must be evaluated
      Returns:
        value of the linear equation at the current point

    - #### equals

          public boolean equals(Object other)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.