Java Reference

Java Reference

CpObjectiveProto.Builder

Detailed Description

Optimization objective.
This is in a message because decision problems don't have any objective.

Protobuf type

operations_research.sat.CpObjectiveProto

Definition at line 585 of file CpObjectiveProto.java.

Public Member Functions

.lang.Override Builder clear ()
 
.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
.lang.Override com.google.ortools.sat.CpObjectiveProto getDefaultInstanceForType ()
 
.lang.Override com.google.ortools.sat.CpObjectiveProto build ()
 
.lang.Override com.google.ortools.sat.CpObjectiveProto buildPartial ()
 
.lang.Override Builder clone ()
 
.lang.Override Builder setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
 
.lang.Override Builder clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
 
.lang.Override Builder setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
 
.lang.Override Builder addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (com.google.ortools.sat.CpObjectiveProto other)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
java.util.List< java.lang.Integer > getVarsList ()
 
int getVarsCount ()
 
int getVars (int index)
 
Builder setVars (int index, int value)
 
Builder addVars (int value)
 
Builder addAllVars (java.lang.Iterable<? extends java.lang.Integer > values)
 
Builder clearVars ()
 
java.util.List< java.lang.Long > getCoeffsList ()
 repeated int64 coeffs = 4; More...
 
int getCoeffsCount ()
 repeated int64 coeffs = 4; More...
 
long getCoeffs (int index)
 repeated int64 coeffs = 4; More...
 
Builder setCoeffs (int index, long value)
 repeated int64 coeffs = 4; More...
 
Builder addCoeffs (long value)
 repeated int64 coeffs = 4; More...
 
Builder addAllCoeffs (java.lang.Iterable<? extends java.lang.Long > values)
 repeated int64 coeffs = 4; More...
 
Builder clearCoeffs ()
 repeated int64 coeffs = 4; More...
 
.lang.Override double getOffset ()
 
Builder setOffset (double value)
 
Builder clearOffset ()
 
.lang.Override double getScalingFactor ()
 double scaling_factor = 3; More...
 
Builder setScalingFactor (double value)
 double scaling_factor = 3; More...
 
Builder clearScalingFactor ()
 double scaling_factor = 3; More...
 
java.util.List< java.lang.Long > getDomainList ()
 
int getDomainCount ()
 
long getDomain (int index)
 
Builder setDomain (int index, long value)
 
Builder addDomain (long value)
 
Builder addAllDomain (java.lang.Iterable<? extends java.lang.Long > values)
 
Builder clearDomain ()
 
.lang.Override final Builder setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 
.lang.Override final Builder mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 

Protected Member Functions

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 

Member Function Documentation

◆ addAllCoeffs()

Builder addAllCoeffs ( java.lang.Iterable<? extends java.lang.Long >  values)
inline

repeated int64 coeffs = 4;

Parameters
valuesThe coeffs to add.
Returns
This builder for chaining.

Definition at line 969 of file CpObjectiveProto.java.

◆ addAllDomain()

Builder addAllDomain ( java.lang.Iterable<? extends java.lang.Long >  values)
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Parameters
valuesThe domain to add.
Returns
This builder for chaining.

Definition at line 1173 of file CpObjectiveProto.java.

◆ addAllVars()

Builder addAllVars ( java.lang.Iterable<? extends java.lang.Integer >  values)
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Parameters
valuesThe vars to add.
Returns
This builder for chaining.

Definition at line 884 of file CpObjectiveProto.java.

◆ addCoeffs()

Builder addCoeffs ( long  value)
inline

repeated int64 coeffs = 4;

Parameters
valueThe coeffs to add.
Returns
This builder for chaining.

Definition at line 958 of file CpObjectiveProto.java.

◆ addDomain()

Builder addDomain ( long  value)
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Parameters
valueThe domain to add.
Returns
This builder for chaining.

Definition at line 1156 of file CpObjectiveProto.java.

◆ addRepeatedField()

.lang.Override Builder addRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 705 of file CpObjectiveProto.java.

◆ addVars()

Builder addVars ( int  value)
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Parameters
valueThe vars to add.
Returns
This builder for chaining.

Definition at line 867 of file CpObjectiveProto.java.

◆ build()

.lang.Override com.google.ortools.sat.CpObjectiveProto build ( )
inline

Definition at line 645 of file CpObjectiveProto.java.

◆ buildPartial()

.lang.Override com.google.ortools.sat.CpObjectiveProto buildPartial ( )
inline

Definition at line 654 of file CpObjectiveProto.java.

◆ clear()

.lang.Override Builder clear ( )
inline

Definition at line 618 of file CpObjectiveProto.java.

◆ clearCoeffs()

Builder clearCoeffs ( )
inline

repeated int64 coeffs = 4;

Returns
This builder for chaining.

Definition at line 981 of file CpObjectiveProto.java.

◆ clearDomain()

Builder clearDomain ( )
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Returns
This builder for chaining.

Definition at line 1191 of file CpObjectiveProto.java.

◆ clearField()

.lang.Override Builder clearField ( com.google.protobuf.Descriptors.FieldDescriptor  field)
inline

Definition at line 689 of file CpObjectiveProto.java.

◆ clearOffset()

Builder clearOffset ( )
inline
The displayed objective is always:
  scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset).
This is needed to have a consistent objective after presolve or when
scaling a double problem to express it with integers.
Note that if scaling_factor is zero, then it is assumed to be 1, so that by
default these fields have no effect.

double offset = 2;

Returns
This builder for chaining.

Definition at line 1039 of file CpObjectiveProto.java.

◆ clearOneof()

.lang.Override Builder clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor  oneof)
inline

Definition at line 694 of file CpObjectiveProto.java.

◆ clearScalingFactor()

Builder clearScalingFactor ( )
inline

double scaling_factor = 3;

Returns
This builder for chaining.

Definition at line 1070 of file CpObjectiveProto.java.

◆ clearVars()

Builder clearVars ( )
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Returns
This builder for chaining.

Definition at line 902 of file CpObjectiveProto.java.

◆ clone()

.lang.Override Builder clone ( )
inline

Definition at line 679 of file CpObjectiveProto.java.

◆ getCoeffs()

long getCoeffs ( int  index)
inline

repeated int64 coeffs = 4;

Parameters
indexThe index of the element to return.
Returns
The coeffs at the given index.

Implements CpObjectiveProtoOrBuilder.

Definition at line 937 of file CpObjectiveProto.java.

◆ getCoeffsCount()

int getCoeffsCount ( )
inline

repeated int64 coeffs = 4;

Returns
The count of coeffs.

Implements CpObjectiveProtoOrBuilder.

Definition at line 929 of file CpObjectiveProto.java.

◆ getCoeffsList()

java.util.List<java.lang.Long> getCoeffsList ( )
inline

repeated int64 coeffs = 4;

Returns
A list containing the coeffs.

Implements CpObjectiveProtoOrBuilder.

Definition at line 921 of file CpObjectiveProto.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.sat.CpObjectiveProto getDefaultInstanceForType ( )
inline

Definition at line 640 of file CpObjectiveProto.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ( )
inlinestatic

Definition at line 590 of file CpObjectiveProto.java.

◆ getDescriptorForType()

.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ( )
inline

Definition at line 635 of file CpObjectiveProto.java.

◆ getDomain()

long getDomain ( int  index)
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Parameters
indexThe index of the element to return.
Returns
The domain at the given index.

Implements CpObjectiveProtoOrBuilder.

Definition at line 1123 of file CpObjectiveProto.java.

◆ getDomainCount()

int getDomainCount ( )
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Returns
The count of domain.

Implements CpObjectiveProtoOrBuilder.

Definition at line 1109 of file CpObjectiveProto.java.

◆ getDomainList()

java.util.List<java.lang.Long> getDomainList ( )
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Returns
A list containing the domain.

Implements CpObjectiveProtoOrBuilder.

Definition at line 1095 of file CpObjectiveProto.java.

◆ getOffset()

.lang.Override double getOffset ( )
inline
The displayed objective is always:
  scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset).
This is needed to have a consistent objective after presolve or when
scaling a double problem to express it with integers.
Note that if scaling_factor is zero, then it is assumed to be 1, so that by
default these fields have no effect.

double offset = 2;

Returns
The offset.

Implements CpObjectiveProtoOrBuilder.

Definition at line 1003 of file CpObjectiveProto.java.

◆ getScalingFactor()

.lang.Override double getScalingFactor ( )
inline

double scaling_factor = 3;

Returns
The scalingFactor.

Implements CpObjectiveProtoOrBuilder.

Definition at line 1052 of file CpObjectiveProto.java.

◆ getVars()

int getVars ( int  index)
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Parameters
indexThe index of the element to return.
Returns
The vars at the given index.

Implements CpObjectiveProtoOrBuilder.

Definition at line 834 of file CpObjectiveProto.java.

◆ getVarsCount()

int getVarsCount ( )
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Returns
The count of vars.

Implements CpObjectiveProtoOrBuilder.

Definition at line 820 of file CpObjectiveProto.java.

◆ getVarsList()

java.util.List<java.lang.Integer> getVarsList ( )
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Returns
A list containing the vars.

Implements CpObjectiveProtoOrBuilder.

Definition at line 806 of file CpObjectiveProto.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
inlineprotected

Definition at line 596 of file CpObjectiveProto.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 764 of file CpObjectiveProto.java.

◆ mergeFrom() [1/3]

Builder mergeFrom ( com.google.ortools.sat.CpObjectiveProto  other)
inline

Definition at line 720 of file CpObjectiveProto.java.

◆ mergeFrom() [2/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inline

Definition at line 769 of file CpObjectiveProto.java.

◆ mergeFrom() [3/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.Message  other)
inline

Definition at line 711 of file CpObjectiveProto.java.

◆ mergeUnknownFields()

.lang.Override final Builder mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1204 of file CpObjectiveProto.java.

◆ setCoeffs()

Builder setCoeffs ( int  index,
long  value 
)
inline

repeated int64 coeffs = 4;

Parameters
indexThe index to set the value at.
valueThe coeffs to set.
Returns
This builder for chaining.

Definition at line 946 of file CpObjectiveProto.java.

◆ setDomain()

Builder setDomain ( int  index,
long  value 
)
inline
If non-empty, only look for an objective value in the given domain.
Note that this does not depend on the offset or scaling factor, it is a
domain on the sum of the objective terms only.

repeated int64 domain = 5;

Parameters
indexThe index to set the value at.
valueThe domain to set.
Returns
This builder for chaining.

Definition at line 1138 of file CpObjectiveProto.java.

◆ setField()

.lang.Override Builder setField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 683 of file CpObjectiveProto.java.

◆ setOffset()

Builder setOffset ( double  value)
inline
The displayed objective is always:
  scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset).
This is needed to have a consistent objective after presolve or when
scaling a double problem to express it with integers.
Note that if scaling_factor is zero, then it is assumed to be 1, so that by
default these fields have no effect.

double offset = 2;

Parameters
valueThe offset to set.
Returns
This builder for chaining.

Definition at line 1020 of file CpObjectiveProto.java.

◆ setRepeatedField()

.lang.Override Builder setRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
int  index,
java.lang.Object  value 
)
inline

Definition at line 699 of file CpObjectiveProto.java.

◆ setScalingFactor()

Builder setScalingFactor ( double  value)
inline

double scaling_factor = 3;

Parameters
valueThe scalingFactor to set.
Returns
This builder for chaining.

Definition at line 1060 of file CpObjectiveProto.java.

◆ setUnknownFields()

.lang.Override final Builder setUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1198 of file CpObjectiveProto.java.

◆ setVars()

Builder setVars ( int  index,
int  value 
)
inline
The linear terms of the objective to minimize.
For a maximization problem, one can negate all coefficients in the
objective and set a scaling_factor to -1.

repeated int32 vars = 1;

Parameters
indexThe index to set the value at.
valueThe vars to set.
Returns
This builder for chaining.

Definition at line 849 of file CpObjectiveProto.java.


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