Description
The ParetoFront object stores the set of optimal solutions found during a multi-objective optimization process. Each solution in the Pareto front represents a trade-off between the defined objectives such that no objective can be improved without degrading another. The ParetoFront object provides access to the full set of solutions as well as filtered and sorted subsets, and includes methods for adding solution filters, setting sorting criteria, and retrieving state variable and objective values from the solutions.
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->ParetoFront
Parent Object: MultiObjectiveOptimizer
Available In Editions:
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
AllowTiedSolutions
|
The value of this property decides whether tied solutions (solutions that have identical objective values but different state variables) will be deemed dominated and rejected from the pareto front or deemed non-dominated and allowed into the pareto front.
|
Type: Variable
Access: Read/Write
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
FilteredSolutions
|
The non-dominated solutions comprising the ParetoFront after filters have been applied. Filters are added using the ParetoFront.AddSolutionFilter method.
|
Type: Array of ParetoFrontSolution
Access: Read-Only
|
HypervolumeStallMetric
|
The percent change in pareto front hypervolume averaged over the last N generations where N is equal to the MultiObjectiveOptimizer.HypervolumeStallWindow property. The hypervolume computation uses the nadir point of the pareto front as the reference point, and decreases in hypervolume due to nadir point movement are ignored. This property can be used to gain insight on the progress of the optimizer while it is running.
|
Type: Variable
Access: Read-Only
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
Solutions
|
The non-dominated solutions comprising the ParetoFront.
|
Type: Array of ParetoFrontSolution
Access: Read-Only
|
|
Name
|
Description
|
AddSolutionFilter
|
Prevents solutions that do not meet the specified threshold from appearing in the ParetoFront.FilteredSolutions array. For maximizing objectives, only solutions with objective values greater than or equal to the threshold argument will pass the filter. For minimizing objectives, only solutions with objective values less than or equal to the threshold argument will pass the filter. Use the ParetoFront.ClearObjectiveFilters method to remove all filters.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
ClearSolutionFilters
|
Restores all solutions that have been filtered out of the ParetoFront.FilteredSolutions array using the ParetoFront.AddSolutionFilter method.
|
CullSolutions
|
After calling this method, the ParetoFront.Solutions array will contain a maximum of N solutions where N is equal to the numberOfSolutions argument. If the number of existing solutions is greater than N, the solutions to be culled will be determined using a clustering algorithm such that the resulting distribution of solutions is spread evenly along the pareto front.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
GetHypervolume
|
Returns the N-dimensional volume of the pareto front where N is equal to the number of objectives.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetSolutionSortingCriteria
|
Adds multiple solution sorting criteria. The elements of the ParetoFront.Solutions and ParetoFront.FilteredSolutions properties will appear sorted according to these criteria. Maximizing objectives are sorted greatest to least and minimizing objectives are sorted least to greatest.
|
|
|
