Java Reference

Java Reference

Detailed Description

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

Definition at line 17 of file WeightedSumExpression.java.

Public Member Functions

 WeightedSumExpression (int[] variablesIndices, long[] coefficients, long offset)
 
LinearExpr build ()
 Builds a linear expression. More...
 
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...
 
long getCoefficient (int index)
 Returns the ith coefficient. More...
 
long getOffset ()
 Returns the constant part of the expression. More...
 

Static Public Member Functions

static LinearExprBuilder newBuilder ()
 Returns a builder. More...
 
static LinearExpr constant (long value)
 Shortcut for newBuilder().add(value).build() More...
 
static LinearExpr term (LinearArgument expr, long coeff)
 Shortcut for newBuilder().addTerm(expr, coeff).build() More...
 
static LinearExpr affine (LinearArgument expr, long coeff, long 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, long[] coeffs)
 Shortcut for newBuilder().addWeightedSum(exprs, coeffs).build() More...
 
static LinearExpr rebuildFromLinearExpressionProto (LinearExpressionProto proto)
 

Constructor & Destructor Documentation

◆ WeightedSumExpression()

WeightedSumExpression ( int[]  variablesIndices,
long[]  coefficients,
long  offset 
)

Definition at line 22 of file WeightedSumExpression.java.

Member Function Documentation

◆ affine()

static LinearExpr affine ( LinearArgument  expr,
long  coeff,
long  offset 
)
staticinherited

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

Definition at line 48 of file LinearExpr.java.

◆ build()

LinearExpr build ( )

Builds a linear expression.

Implements LinearArgument.

Definition at line 29 of file WeightedSumExpression.java.

◆ constant()

static LinearExpr constant ( long  value)
staticinherited

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

Definition at line 38 of file LinearExpr.java.

◆ getCoefficient()

long getCoefficient ( int  index)

Returns the ith coefficient.

Implements LinearExpr.

Definition at line 47 of file WeightedSumExpression.java.

◆ getOffset()

long getOffset ( )

Returns the constant part of the expression.

Implements LinearExpr.

Definition at line 55 of file WeightedSumExpression.java.

◆ getVariableIndex()

int getVariableIndex ( int  index)

Returns the index of the ith variable.

Implements LinearExpr.

Definition at line 39 of file WeightedSumExpression.java.

◆ newBuilder()

static LinearExprBuilder newBuilder ( )
staticinherited

Returns a builder.

Definition at line 33 of file LinearExpr.java.

◆ numElements()

int numElements ( )

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

Implements LinearExpr.

Definition at line 34 of file WeightedSumExpression.java.

◆ rebuildFromLinearExpressionProto()

static LinearExpr rebuildFromLinearExpressionProto ( LinearExpressionProto  proto)
staticinherited

Definition at line 62 of file LinearExpr.java.

◆ sum()

static LinearExpr sum ( LinearArgument[]  exprs)
staticinherited

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

Definition at line 53 of file LinearExpr.java.

◆ term()

static LinearExpr term ( LinearArgument  expr,
long  coeff 
)
staticinherited

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

Definition at line 43 of file LinearExpr.java.

◆ weightedSum()

static LinearExpr weightedSum ( LinearArgument[]  exprs,
long[]  coeffs 
)
staticinherited

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

Definition at line 58 of file LinearExpr.java.


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