Initializing help system before first use

LinExpression

  • Direct Known Subclasses:
    LinTermList, LinTermMap 
    public abstract class LinExpression
extends AbstractExpression
    A linear expression that represents its data by a collection of terms. This is an abstract base class that is implement by different subclasses which use different data types to actually store the various terms in the expression.
    Since:
    43.00

    • Constructor Detail

      • LinExpression

        public LinExpression()

    • Method Detail

      • deepCopy

        public abstract LinExpression deepCopy()
        Get a deep copy of this expression.
        Returns:
        A deep copy of this expression.
        Since:
        43.00

      • deepCopy

        public abstract LinExpression deepCopy​(double factor)
        Get a deep copy of this expression multiplied by a constant
        Parameters:
        factor - Factor to scale this with.
        Returns:
        A deep copy of this expression multiplied by factor.
        Since:
        43.00

      • getConstant

        public abstract double getConstant()
        Get the constant value in this expression.
        Returns:
        The constant value in this expression.
        Since:
        43.00

      • addConstant

        public abstract LinExpression addConstant​(double c)
        Add a value to the constant term of this expression.
        Parameters:
        c - The constant to add.
        Returns:
        Always returns this.
        Since:
        43.00

      • setConstant

        public abstract LinExpression setConstant​(double c)
        Set the constant term in this expression. Any existing constant term will be overwritten.
        Parameters:
        c - New constant term for this expression
        Returns:
        Always returns this.
        Since:
        43.00

      • reset

        public abstract LinExpression reset()
        Clear this expression. Removes all terms and sets the constant to 0.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerms

        public abstract LinExpression addTerms​(java.util.Collection<Variable> variables,
                                       java.util.Collection<java.lang.Double> coefficients)
        Add multiple terms to this expression. Adds the scalar product defined by the two parallel collections to this expression.
        Parameters:
        variables - Variables.
        coefficients - Coefficients.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerms

        public abstract LinExpression addTerms​(Variable[] variables,
                                       double[] coefficients)
        Add multiple terms to this expression. Adds the scalar product defined by the two parallel arrays to this expression. This function is equivalent to 
          for (int i = 0; i < variables.length; ++i) addTerm(variables[i], coefficients[i]);
        Parameters:
        variables - Variables
        coefficients - Coefficients
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerm

        public abstract LinExpression addTerm​(Variable variable,
                                      double coefficient)
        Add a term to this expression. If the expression already has a coefficient for variable then the old and the new coefficients will be added.
        Parameters:
        variable - Variable.
        coefficient - Coefficient to add for variable.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerm

        public abstract LinExpression addTerm​(double coefficient,
                                      Variable variable)
        Add a term to this expression. If the expression already has a coefficient for variable then the old and the new coefficients will be added.
        Parameters:
        coefficient - Coefficient to add for variable.
        variable - Variable.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerm

        public LinExpression addTerm​(LinTerm term)
        Add term term to this expression.
        Parameters:
        term - The term to add.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerm

        public abstract LinExpression addTerm​(Variable x)
        Add term 1*x this expression. If the expression already has a coefficient for x then the old and the new coefficients will be added.
        Parameters:
        x - Variable.
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerms

        public abstract LinExpression addTerms​(LinExpression expr)
        Add another linear expression to this expression.
        Parameters:
        expr - The expression to add
        Returns:
        Always returns this.
        Since:
        43.00

      • addTerms

        public abstract LinExpression addTerms​(LinExpression expr,
                                       double factor)
        Add another linear expression to this expression.
        Parameters:
        expr - The expression to add.
        factor - Factor by which to multiply elements in expr before adding.
        Returns:
        Always returns this.
        Since:
        43.00

      • square

        public Expression square()
        Create a new QuadExpression by multiplying this expression by itself.
        Returns:
        New expression that represents the product of this with itself.
        Since:
        43.00

      • create

        public static LinExpression create()
        Create a new empty linear expression.
        Returns:
        The new linear expression.
        Since:
        43.00

      • create

        public static LinExpression create​(double constant)
        Create a new linear expression with the specified constant term.
        Parameters:
        constant - The constant term to which the expression is initialized.
        Returns:
        The new quadratic expression.
        Since:
        43.00

      • toString

        public java.lang.String toString()

        Used in these examples:

        • GlobalRHSParametrics
        • IISExample
        • Knapsack
        • Trimloss
        Overrides:
        toString in class  java.lang.Object
        Since:
        43.00
Parent Topic Class Summary

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.