Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Google.OrTools.ConstraintSolver.SavingsParameters Class Referencesealed

Parameters used to configure savings heuristics. More...

Detailed Description

Parameters used to configure savings heuristics.

Definition at line 398 of file RoutingHeuristicParameters.pb.cs.

Inheritance diagram for Google.OrTools.ConstraintSolver.SavingsParameters:

Public Member Functions

 SavingsParameters ()
 SavingsParameters (SavingsParameters other)
SavingsParameters Clone ()
override bool Equals (object other)
bool Equals (SavingsParameters other)
override int GetHashCode ()
override string ToString ()
void WriteTo (pb::CodedOutputStream output)
int CalculateSize ()
void MergeFrom (SavingsParameters other)
void MergeFrom (pb::CodedInputStream input)

Static Public Attributes

const int NeighborsRatioFieldNumber = 1
 Field number for the "neighbors_ratio" field.
const int MaxMemoryUsageBytesFieldNumber = 2
 Field number for the "max_memory_usage_bytes" field.
const int AddReverseArcsFieldNumber = 3
 Field number for the "add_reverse_arcs" field.
const int ArcCoefficientFieldNumber = 4
 Field number for the "arc_coefficient" field.

Properties

static pb::MessageParser< SavingsParameters > Parser [get]
static pbr::MessageDescriptor Descriptor [get]
double NeighborsRatio [get, set]
 Ratio (in ]0, 1]) of neighbors to consider for each node when constructing the savings. If unspecified, its value is considered to be 1.0.
double MaxMemoryUsageBytes [get, set]
 The number of neighbors considered for each node in the Savings heuristic is chosen so that the space used to store the savings doesn't exceed max_memory_usage_bytes, which must be in ]0, 1e10].
bool AddReverseArcs [get, set]
 Add savings related to reverse arcs when finding the nearest neighbors of the nodes.
double ArcCoefficient [get, set]
 Coefficient of the cost of the arc for which the saving value is being computed: Saving(a-->b) = Cost(a-->end) + Cost(start-->b).

Constructor & Destructor Documentation

◆ SavingsParameters() [1/2]

Google.OrTools.ConstraintSolver.SavingsParameters.SavingsParameters ( )
inline

Definition at line 423 of file RoutingHeuristicParameters.pb.cs.

◆ SavingsParameters() [2/2]

Google.OrTools.ConstraintSolver.SavingsParameters.SavingsParameters ( SavingsParameters other)
inline

Definition at line 431 of file RoutingHeuristicParameters.pb.cs.

Member Function Documentation

◆ CalculateSize()

int Google.OrTools.ConstraintSolver.SavingsParameters.CalculateSize ( )
inline

Definition at line 614 of file RoutingHeuristicParameters.pb.cs.

◆ Clone()

SavingsParameters Google.OrTools.ConstraintSolver.SavingsParameters.Clone ( )
inline

Definition at line 441 of file RoutingHeuristicParameters.pb.cs.

◆ Equals() [1/2]

override bool Google.OrTools.ConstraintSolver.SavingsParameters.Equals ( object other)
inline

Definition at line 518 of file RoutingHeuristicParameters.pb.cs.

◆ Equals() [2/2]

bool Google.OrTools.ConstraintSolver.SavingsParameters.Equals ( SavingsParameters other)
inline

Definition at line 524 of file RoutingHeuristicParameters.pb.cs.

◆ GetHashCode()

override int Google.OrTools.ConstraintSolver.SavingsParameters.GetHashCode ( )
inline

Definition at line 540 of file RoutingHeuristicParameters.pb.cs.

◆ MergeFrom() [1/2]

void Google.OrTools.ConstraintSolver.SavingsParameters.MergeFrom ( pb.CodedInputStream input)
inline

Definition at line 657 of file RoutingHeuristicParameters.pb.cs.

◆ MergeFrom() [2/2]

void Google.OrTools.ConstraintSolver.SavingsParameters.MergeFrom ( SavingsParameters other)
inline

Definition at line 636 of file RoutingHeuristicParameters.pb.cs.

◆ ToString()

override string Google.OrTools.ConstraintSolver.SavingsParameters.ToString ( )
inline

Definition at line 554 of file RoutingHeuristicParameters.pb.cs.

◆ WriteTo()

void Google.OrTools.ConstraintSolver.SavingsParameters.WriteTo ( pb.CodedOutputStream output)
inline

Definition at line 560 of file RoutingHeuristicParameters.pb.cs.

Member Data Documentation

◆ AddReverseArcsFieldNumber

const int Google.OrTools.ConstraintSolver.SavingsParameters.AddReverseArcsFieldNumber = 3
static

Field number for the "add_reverse_arcs" field.

Definition at line 482 of file RoutingHeuristicParameters.pb.cs.

◆ ArcCoefficientFieldNumber

const int Google.OrTools.ConstraintSolver.SavingsParameters.ArcCoefficientFieldNumber = 4
static

Field number for the "arc_coefficient" field.

Definition at line 498 of file RoutingHeuristicParameters.pb.cs.

◆ MaxMemoryUsageBytesFieldNumber

const int Google.OrTools.ConstraintSolver.SavingsParameters.MaxMemoryUsageBytesFieldNumber = 2
static

Field number for the "max_memory_usage_bytes" field.

Definition at line 462 of file RoutingHeuristicParameters.pb.cs.

◆ NeighborsRatioFieldNumber

const int Google.OrTools.ConstraintSolver.SavingsParameters.NeighborsRatioFieldNumber = 1
static

Field number for the "neighbors_ratio" field.

Definition at line 446 of file RoutingHeuristicParameters.pb.cs.

Property Documentation

◆ AddReverseArcs

bool Google.OrTools.ConstraintSolver.SavingsParameters.AddReverseArcs
getset

Add savings related to reverse arcs when finding the nearest neighbors of the nodes.

Definition at line 490 of file RoutingHeuristicParameters.pb.cs.

◆ ArcCoefficient

double Google.OrTools.ConstraintSolver.SavingsParameters.ArcCoefficient
getset

Coefficient of the cost of the arc for which the saving value is being computed: Saving(a-->b) = Cost(a-->end) + Cost(start-->b).

  • arc_coefficient * Cost(a-->b) This parameter must be greater than 0, and its default value is 1.

Definition at line 509 of file RoutingHeuristicParameters.pb.cs.

◆ Descriptor

pbr.MessageDescriptor Google.OrTools.ConstraintSolver.SavingsParameters.Descriptor
staticget

Definition at line 411 of file RoutingHeuristicParameters.pb.cs.

◆ MaxMemoryUsageBytes

double Google.OrTools.ConstraintSolver.SavingsParameters.MaxMemoryUsageBytes
getset

The number of neighbors considered for each node in the Savings heuristic is chosen so that the space used to store the savings doesn't exceed max_memory_usage_bytes, which must be in ]0, 1e10].

Note
If both neighbors_ratio and max_memory_usage_bytes are specified, the number of neighbors considered for each node will be the minimum of the two numbers determined by these parameters.

Definition at line 474 of file RoutingHeuristicParameters.pb.cs.

◆ NeighborsRatio

double Google.OrTools.ConstraintSolver.SavingsParameters.NeighborsRatio
getset

Ratio (in ]0, 1]) of neighbors to consider for each node when constructing the savings. If unspecified, its value is considered to be 1.0.

Definition at line 454 of file RoutingHeuristicParameters.pb.cs.

◆ Parser

pb.MessageParser<SavingsParameters> Google.OrTools.ConstraintSolver.SavingsParameters.Parser
staticget

Definition at line 407 of file RoutingHeuristicParameters.pb.cs.

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