Java Reference

Java Reference

Detailed Description

A linear expression (sum (ai * xi) + b).

It specifies methods to help parsing the expression.

Definition at line 17 of file modelbuilder/LinearExpr.java.

Public Member Functions
int	numElements ()
	Returns the number of terms (excluding the constant one) in this expression. More...

int	getVariableIndex (int index)
	Returns the index of the ith variable. More...

double	getCoefficient (int index)
	Returns the ith coefficient. More...

double	getOffset ()
	Returns the constant part of the expression. More...

LinearExpr	build ()
	Builds a linear expression. More...

Static Public Member Functions
static LinearExprBuilder	newBuilder ()
	Returns a builder. More...

static LinearExpr	constant (double value)
	Shortcut for newBuilder().add(value).build() More...

static LinearExpr	term (LinearArgument expr, double coeff)
	Shortcut for newBuilder().addTerm(expr, coeff).build() More...

static LinearExpr	affine (LinearArgument expr, double coeff, double offset)
	Shortcut for newBuilder().addTerm(expr, coeff).add(offset).build() More...

static LinearExpr	sum (LinearArgument[] exprs)
	Shortcut for newBuilder().addSum(exprs).build() More...

static LinearExpr	weightedSum (LinearArgument[] exprs, double[] coeffs)
	Shortcut for newBuilder().addWeightedSum(exprs, coeffs).build() More...

Member Function Documentation

◆ affine()

static LinearExpr affine	(	LinearArgument	expr,
		double	coeff,
		double	offset
	)

static

Shortcut for newBuilder().addTerm(expr, coeff).add(offset).build()

Definition at line 46 of file modelbuilder/LinearExpr.java.

◆ build()

LinearExpr build ( )

inherited

Builds a linear expression.

Implemented in WeightedSumExpression, Variable, LinearExprBuilder, ConstantExpression, and AffineExpression.

◆ constant()

static LinearExpr constant ( double value )

static

Shortcut for newBuilder().add(value).build()

Definition at line 36 of file modelbuilder/LinearExpr.java.

◆ getCoefficient()

double getCoefficient ( int index )

Returns the ith coefficient.

Implemented in WeightedSumExpression, ConstantExpression, and AffineExpression.

◆ getOffset()

double getOffset ( )

Returns the constant part of the expression.

Implemented in WeightedSumExpression, ConstantExpression, and AffineExpression.

◆ getVariableIndex()

int getVariableIndex ( int index )

Returns the index of the ith variable.

Implemented in WeightedSumExpression, ConstantExpression, and AffineExpression.

◆ newBuilder()

static LinearExprBuilder newBuilder ( )

static

Returns a builder.

Definition at line 31 of file modelbuilder/LinearExpr.java.

◆ numElements()

int numElements ( )

Returns the number of terms (excluding the constant one) in this expression.

Implemented in WeightedSumExpression, ConstantExpression, and AffineExpression.

◆ sum()

static LinearExpr sum ( LinearArgument[] exprs )

static

Shortcut for newBuilder().addSum(exprs).build()

Definition at line 51 of file modelbuilder/LinearExpr.java.

◆ term()

static LinearExpr term	(	LinearArgument	expr,
		double	coeff
	)

static

Shortcut for newBuilder().addTerm(expr, coeff).build()

Definition at line 41 of file modelbuilder/LinearExpr.java.

◆ weightedSum()

static LinearExpr weightedSum	(	LinearArgument[]	exprs,
		double[]	coeffs
	)

static

Shortcut for newBuilder().addWeightedSum(exprs, coeffs).build()

Definition at line 56 of file modelbuilder/LinearExpr.java.

The documentation for this interface was generated from the following file:

modelbuilder/LinearExpr.java