DotNet Reference
DotNet Reference
Detailed Description
Optimization objective.
This is in a message because decision problems don't have any objective.
Definition at line 4840 of file CpModel.pb.cs.
Public Member Functions | |
| CpObjectiveProto () | |
| CpObjectiveProto (CpObjectiveProto other) | |
| CpObjectiveProto | Clone () |
| override bool | Equals (object other) |
| bool | Equals (CpObjectiveProto other) |
| override int | GetHashCode () |
| override string | ToString () |
| void | WriteTo (pb::CodedOutputStream output) |
| int | CalculateSize () |
| void | MergeFrom (CpObjectiveProto other) |
| void | MergeFrom (pb::CodedInputStream input) |
Static Public Attributes | |
| const int | VarsFieldNumber = 1 |
| Field number for the "vars" field. More... | |
| const int | CoeffsFieldNumber = 4 |
| Field number for the "coeffs" field. More... | |
| const int | OffsetFieldNumber = 2 |
| Field number for the "offset" field. More... | |
| const int | ScalingFactorFieldNumber = 3 |
| Field number for the "scaling_factor" field. More... | |
| const int | DomainFieldNumber = 5 |
| Field number for the "domain" field. More... | |
Properties | |
| static pb::MessageParser< CpObjectiveProto > | Parser [get] |
| static pbr::MessageDescriptor | Descriptor [get] |
| pbc::RepeatedField< int > | Vars [get] |
| The linear terms of the objective to minimize. More... | |
| pbc::RepeatedField< long > | Coeffs [get] |
| double | Offset [get, set] |
| The displayed objective is always: scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset). More... | |
| double | ScalingFactor [get, set] |
| pbc::RepeatedField< long > | Domain [get] |
| If non-empty, only look for an objective value in the given domain. More... | |
Constructor & Destructor Documentation
◆ CpObjectiveProto() [1/2]
|
inline |
Definition at line 4857 of file CpModel.pb.cs.
◆ CpObjectiveProto() [2/2]
|
inline |
Definition at line 4864 of file CpModel.pb.cs.
Member Function Documentation
◆ CalculateSize()
|
inline |
Definition at line 5008 of file CpModel.pb.cs.
◆ Clone()
|
inline |
Definition at line 4874 of file CpModel.pb.cs.
◆ Equals() [1/2]
|
inline |
Definition at line 4955 of file CpModel.pb.cs.
◆ Equals() [2/2]
|
inline |
Definition at line 4950 of file CpModel.pb.cs.
◆ GetHashCode()
|
inline |
Definition at line 4971 of file CpModel.pb.cs.
◆ MergeFrom() [1/2]
|
inline |
Definition at line 5026 of file CpModel.pb.cs.
◆ MergeFrom() [2/2]
|
inline |
Definition at line 5043 of file CpModel.pb.cs.
◆ ToString()
|
inline |
Definition at line 4985 of file CpModel.pb.cs.
◆ WriteTo()
|
inline |
Definition at line 4990 of file CpModel.pb.cs.
Member Data Documentation
◆ CoeffsFieldNumber
|
static |
Field number for the "coeffs" field.
Definition at line 4894 of file CpModel.pb.cs.
◆ DomainFieldNumber
|
static |
Field number for the "domain" field.
Definition at line 4935 of file CpModel.pb.cs.
◆ OffsetFieldNumber
|
static |
Field number for the "offset" field.
Definition at line 4904 of file CpModel.pb.cs.
◆ ScalingFactorFieldNumber
|
static |
Field number for the "scaling_factor" field.
Definition at line 4924 of file CpModel.pb.cs.
◆ VarsFieldNumber
|
static |
Field number for the "vars" field.
Definition at line 4879 of file CpModel.pb.cs.
Property Documentation
◆ Coeffs
|
get |
Definition at line 4899 of file CpModel.pb.cs.
◆ Descriptor
|
staticget |
Definition at line 4847 of file CpModel.pb.cs.
◆ Domain
|
get |
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.
Definition at line 4945 of file CpModel.pb.cs.
◆ Offset
|
getset |
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.
Definition at line 4916 of file CpModel.pb.cs.
◆ Parser
|
staticget |
Definition at line 4844 of file CpModel.pb.cs.
◆ ScalingFactor
|
getset |
Definition at line 4927 of file CpModel.pb.cs.
◆ Vars
|
get |
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.
Definition at line 4889 of file CpModel.pb.cs.
The documentation for this class was generated from the following file: