C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Optimization.OptimizationResult Class Reference

Object to map metrics on the initial portfolio. More...

Public Member Functions

virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.
 

Properties

Dictionary< string, double > constraints [get, set]
 The set of constraint function results for this candidate.
 
bool feasible [get, set]
 The feasibility of the candidate based on the constraints evaluated by the optimization algorithm for that candidate. If true, the candidate satisfies all constraints. If false, the candidate violates one or more constraints.
 
Dictionary< string, double > objectives [get, set]
 The set of objective function results for this candidate.
 

Detailed Description

Object to map metrics on the initial portfolio.

Definition at line 7 of file OptimizationResult.cs.

Inheritance diagram for AnalyzeRe.Optimization.OptimizationResult:
AnalyzeRe.APIType AnalyzeRe.IAPIType AnalyzeRe.Optimization.Candidate

Member Function Documentation

◆ AfterMembersCloned()

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Overriding implementations should be sure to invoke base.AfterMembersCloned().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.OptimizationView, and AnalyzeRe.StaticSimulation.

Definition at line 37 of file APIType.cs.

◆ ShallowCopy< T >()

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Property Documentation

◆ constraints

Dictionary<string, double> AnalyzeRe.Optimization.OptimizationResult.constraints
getset

The set of constraint function results for this candidate.

Definition at line 15 of file OptimizationResult.cs.

◆ feasible

bool AnalyzeRe.Optimization.OptimizationResult.feasible
getset

The feasibility of the candidate based on the constraints evaluated by the optimization algorithm for that candidate. If true, the candidate satisfies all constraints. If false, the candidate violates one or more constraints.

Definition at line 21 of file OptimizationResult.cs.

◆ objectives

Dictionary<string, double> AnalyzeRe.Optimization.OptimizationResult.objectives
getset

The set of objective function results for this candidate.

Definition at line 11 of file OptimizationResult.cs.


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