org.apache.commons/commons-math3/3.6.1 : org/apache/commons/math3/optimization/linear/LinearConstraint.java

LinearConstraint

http://commons.apache.org/proper/commons-math/: The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang. (The Apache Software Foundation)

Apache License, Version 2.0

Eldar Agalarov
Tim Allison
C. Scott Ananian
Mark Anderson
Peter Andrews
Rémi Arntzen
Matt Adereth
Jared Becksfort
Michael Bjorkegren
Brian Bloniarz
John Bollinger
Cyril Briquet
Dave Brosius
Dan Checkoway
Anders Conbere
Charles Cooper
Paul Cowan
Benjamin Croizet
Larry Diamond
Aleksei Dievskii
Rodrigo di Lorenzo Lopes
Hasan Diwan
Ted Dunning
Ole Ersoy
Ajo Fod
John Gant
Ken Geis
Hank Grabowski
Bernhard Grünewaldt
Elliotte Rusty Harold
Dennis Hendriks
Reid Hochstedler
Matthias Hummel
Curtis Jensen
Bruce A Johnson
Ismael Juma
Eugene Kirpichov
Oleksandr Kornieiev
Piotr Kochanski
Sergei Lebedev
Bob MacCallum
Jake Mannix
Benjamin McCann
Patrick Meyer
J. Lewis Muir
Venkatesha Murthy
Christopher Nix
Fredrik Norin
Sean Owen
Sujit Pal
Todd C. Parnell
Andreas Rieger
Sébastien Riou
Bill Rossi
Matthew Rowles
Pavel Ryzhov
Joni Salonen
Michael Saunders
Thorsten Schaefer
Christopher Schuck
Christian Semrau
David Stefka
Mauro Talevi
Radoslav Tsvetkov
Kim van der Linde
Alexey Volkov
Andrew Waterman
Jörg Weimar
Christian Winter
Piotr Wydrych
Xiaogang Zhang
Chris Popp

Mikkel Meyer Andersen
Bill Barker
Sébastien Brisard
Albert Davidson Chou
Mark Diggory
Robert Burrell Donkin
Otmar Ertl
Luc Maisonobe
Tim O'Brien
J. Pietschmann
Dimitri Pourbaix
Gilles Sadowski
Greg Sterijevski
Brent Worden
Thomas Neidhart
Evan Ward

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.math3.optimization.linear;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

import org.apache.commons.math3.linear.MatrixUtils;
import org.apache.commons.math3.linear.RealVector;
import org.apache.commons.math3.linear.ArrayRealVector;


A linear constraint for a linear optimization problem.

A linear constraint has one of the forms:

  c₁x₁ + ... c_nx_n = v
  c₁x₁ + ... c_nx_n <= v
  c₁x₁ + ... c_nx_n >= v
  l₁x₁ + ... l_nx_n + l_cst =
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst <=
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst >=
      r₁x₁ + ... r_nx_n + r_cst

The c_i, l_i or r_i are the coefficients of the constraints, the x_i
are the coordinates of the current point and v is the value of the constraint.

Deprecated: As of 3.1 (to be removed in 4.0).
Since: 2.0/**
 * A linear constraint for a linear optimization problem.
 * <p>
 * A linear constraint has one of the forms:
 * <ul>
 *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> = v</li>
 *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> &lt;= v</li>
 *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> >= v</li>
 *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> =
 *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
 *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> &lt;=
 *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
 *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> >=
 *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
 * </ul>
 * The c<sub>i</sub>, l<sub>i</sub> or r<sub>i</sub> are the coefficients of the constraints, the x<sub>i</sub>
 * are the coordinates of the current point and v is the value of the constraint.
 * </p>
 * @deprecated As of 3.1 (to be removed in 4.0).
 * @since 2.0
 */
@Deprecated
public class LinearConstraint implements Serializable {

    Serializable version identifier. /** Serializable version identifier. */
    private static final long serialVersionUID = -764632794033034092L;

    Coefficients of the constraint (left hand side). /** Coefficients of the constraint (left hand side). */
    private final transient RealVector coefficients;

    Relationship between left and right hand sides (=, <=, >=). /** Relationship between left and right hand sides (=, &lt;=, >=). */
    private final Relationship relationship;

    Value of the constraint (right hand side). /** Value of the constraint (right hand side). */
    private final double value;

    Build a constraint involving a single linear equation.

A linear constraint with a single linear equation has one of the forms:

  c₁x₁ + ... c_nx_n = v
  c₁x₁ + ... c_nx_n <= v
  c₁x₁ + ... c_nx_n >= v


Params: coefficients – The coefficients of the constraint (left hand side)
relationship – The type of (in)equality used in the constraint
value – The value of the constraint (right hand side)/**
     * Build a constraint involving a single linear equation.
     * <p>
     * A linear constraint with a single linear equation has one of the forms:
     * <ul>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> = v</li>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> &lt;= v</li>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> >= v</li>
     * </ul>
     * </p>
     * @param coefficients The coefficients of the constraint (left hand side)
     * @param relationship The type of (in)equality used in the constraint
     * @param value The value of the constraint (right hand side)
     */
    public LinearConstraint(final double[] coefficients, final Relationship relationship,
                            final double value) {
        this(new ArrayRealVector(coefficients), relationship, value);
    }

    Build a constraint involving a single linear equation.

A linear constraint with a single linear equation has one of the forms:

  c₁x₁ + ... c_nx_n = v
  c₁x₁ + ... c_nx_n <= v
  c₁x₁ + ... c_nx_n >= v


Params: coefficients – The coefficients of the constraint (left hand side)
relationship – The type of (in)equality used in the constraint
value – The value of the constraint (right hand side)/**
     * Build a constraint involving a single linear equation.
     * <p>
     * A linear constraint with a single linear equation has one of the forms:
     * <ul>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> = v</li>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> &lt;= v</li>
     *   <li>c<sub>1</sub>x<sub>1</sub> + ... c<sub>n</sub>x<sub>n</sub> >= v</li>
     * </ul>
     * </p>
     * @param coefficients The coefficients of the constraint (left hand side)
     * @param relationship The type of (in)equality used in the constraint
     * @param value The value of the constraint (right hand side)
     */
    public LinearConstraint(final RealVector coefficients, final Relationship relationship,
                            final double value) {
        this.coefficients = coefficients;
        this.relationship = relationship;
        this.value        = value;
    }

    Build a constraint involving two linear equations.

A linear constraint with two linear equation has one of the forms:

  l₁x₁ + ... l_nx_n + l_cst =
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst <=
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst >=
      r₁x₁ + ... r_nx_n + r_cst


Params: lhsCoefficients – The coefficients of the linear expression on the left hand side of the constraint
lhsConstant – The constant term of the linear expression on the left hand side of the constraint
relationship – The type of (in)equality used in the constraint
rhsCoefficients – The coefficients of the linear expression on the right hand side of the constraint
rhsConstant – The constant term of the linear expression on the right hand side of the constraint/**
     * Build a constraint involving two linear equations.
     * <p>
     * A linear constraint with two linear equation has one of the forms:
     * <ul>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> =
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> &lt;=
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> >=
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     * </ul>
     * </p>
     * @param lhsCoefficients The coefficients of the linear expression on the left hand side of the constraint
     * @param lhsConstant The constant term of the linear expression on the left hand side of the constraint
     * @param relationship The type of (in)equality used in the constraint
     * @param rhsCoefficients The coefficients of the linear expression on the right hand side of the constraint
     * @param rhsConstant The constant term of the linear expression on the right hand side of the constraint
     */
    public LinearConstraint(final double[] lhsCoefficients, final double lhsConstant,
                            final Relationship relationship,
                            final double[] rhsCoefficients, final double rhsConstant) {
        double[] sub = new double[lhsCoefficients.length];
        for (int i = 0; i < sub.length; ++i) {
            sub[i] = lhsCoefficients[i] - rhsCoefficients[i];
        }
        this.coefficients = new ArrayRealVector(sub, false);
        this.relationship = relationship;
        this.value        = rhsConstant - lhsConstant;
    }

    Build a constraint involving two linear equations.

A linear constraint with two linear equation has one of the forms:

  l₁x₁ + ... l_nx_n + l_cst =
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst <=
      r₁x₁ + ... r_nx_n + r_cst
  l₁x₁ + ... l_nx_n + l_cst >=
      r₁x₁ + ... r_nx_n + r_cst


Params: lhsCoefficients – The coefficients of the linear expression on the left hand side of the constraint
lhsConstant – The constant term of the linear expression on the left hand side of the constraint
relationship – The type of (in)equality used in the constraint
rhsCoefficients – The coefficients of the linear expression on the right hand side of the constraint
rhsConstant – The constant term of the linear expression on the right hand side of the constraint/**
     * Build a constraint involving two linear equations.
     * <p>
     * A linear constraint with two linear equation has one of the forms:
     * <ul>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> =
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> &lt;=
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     *   <li>l<sub>1</sub>x<sub>1</sub> + ... l<sub>n</sub>x<sub>n</sub> + l<sub>cst</sub> >=
     *       r<sub>1</sub>x<sub>1</sub> + ... r<sub>n</sub>x<sub>n</sub> + r<sub>cst</sub></li>
     * </ul>
     * </p>
     * @param lhsCoefficients The coefficients of the linear expression on the left hand side of the constraint
     * @param lhsConstant The constant term of the linear expression on the left hand side of the constraint
     * @param relationship The type of (in)equality used in the constraint
     * @param rhsCoefficients The coefficients of the linear expression on the right hand side of the constraint
     * @param rhsConstant The constant term of the linear expression on the right hand side of the constraint
     */
    public LinearConstraint(final RealVector lhsCoefficients, final double lhsConstant,
                            final Relationship relationship,
                            final RealVector rhsCoefficients, final double rhsConstant) {
        this.coefficients = lhsCoefficients.subtract(rhsCoefficients);
        this.relationship = relationship;
        this.value        = rhsConstant - lhsConstant;
    }

    Get the coefficients of the constraint (left hand side).
Returns: coefficients of the constraint (left hand side)/**
     * Get the coefficients of the constraint (left hand side).
     * @return coefficients of the constraint (left hand side)
     */
    public RealVector getCoefficients() {
        return coefficients;
    }

    Get the relationship between left and right hand sides.
Returns: relationship between left and right hand sides/**
     * Get the relationship between left and right hand sides.
     * @return relationship between left and right hand sides
     */
    public Relationship getRelationship() {
        return relationship;
    }

    Get the value of the constraint (right hand side).
Returns: value of the constraint (right hand side)/**
     * Get the value of the constraint (right hand side).
     * @return value of the constraint (right hand side)
     */
    public double getValue() {
        return value;
    }

    {@inheritDoc} /** {@inheritDoc} */
    @Override
    public boolean equals(Object other) {

      if (this == other) {
        return true;
      }

      if (other instanceof LinearConstraint) {
          LinearConstraint rhs = (LinearConstraint) other;
          return (relationship == rhs.relationship) &&
                 (value        == rhs.value) &&
                 coefficients.equals(rhs.coefficients);
      }
      return false;
    }

    {@inheritDoc} /** {@inheritDoc} */
    @Override
    public int hashCode() {
        return relationship.hashCode() ^
               Double.valueOf(value).hashCode() ^
               coefficients.hashCode();
    }

    Serialize the instance.
Params: oos – stream where object should be written
Throws: IOException – if object cannot be written to stream/**
     * Serialize the instance.
     * @param oos stream where object should be written
     * @throws IOException if object cannot be written to stream
     */
    private void writeObject(ObjectOutputStream oos)
        throws IOException {
        oos.defaultWriteObject();
        MatrixUtils.serializeRealVector(coefficients, oos);
    }

    Deserialize the instance.
Params: ois – stream from which the object should be read
Throws: ClassNotFoundException – if a class in the stream cannot be found
IOException – if object cannot be read from the stream/**
     * Deserialize the instance.
     * @param ois stream from which the object should be read
     * @throws ClassNotFoundException if a class in the stream cannot be found
     * @throws IOException if object cannot be read from the stream
     */
    private void readObject(ObjectInputStream ois)
      throws ClassNotFoundException, IOException {
        ois.defaultReadObject();
        MatrixUtils.deserializeRealVector(this, "coefficients", ois);
    }

}

Params:	oos – stream where object should be written
Throws:	IOException – if object cannot be written to stream

Params:	ois – stream from which the object should be read
Throws:	ClassNotFoundException – if a class in the stream cannot be found IOException – if object cannot be read from the stream

/

org.apache.commons/ commons-math3/ 3.6.1/ org/apache/commons/math3/optimization/linear/LinearConstraint.java