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

A candidate is a potential solution to the optimization problem. 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

override void AfterMembersCloned (APIType _)
 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().
 

Properties

string collection_name [get]
 The collection endpoint at which this object resides on the server.
 
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.
 
string id [get, set]
 The resource's unique identifier, used in the REST request URL when requesting the resource from the server.
 
intindex [get, set]
 The index identifying this candidate within an OptimizationView's candidates.
 
Dictionary< string, double > objectives [get, set]
 The set of objective function results for this candidate.
 
IReference< OptimizationViewoptimization_view [get, set]
 The optimization view that owns this candidate.
 
IEnumerable< CandidateParameterparameterization [get, set]
 The parameters of the layer_views that define this candidate.
 
string Path [get]
 The relative path to this candidate from the root URL.
 
SubResource< PortfolioViewportfolio_view [get]
 An endpoint to request the portfolio_view that describes this candidate solution.
 

Detailed Description

A candidate is a potential solution to the optimization problem.

Definition at line 10 of file Candidate.cs.

Inheritance diagram for AnalyzeRe.Optimization.Candidate:
AnalyzeRe.Optimization.OptimizationResult AnalyzeRe.IAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType

Member Function Documentation

◆ AfterMembersCloned()

override void AnalyzeRe.Optimization.Candidate.AfterMembersCloned ( APIType  _)
inlineprotectedvirtual

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().

Reimplemented from AnalyzeRe.APIType.

Definition at line 71 of file Candidate.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

◆ collection_name

string AnalyzeRe.Optimization.Candidate.collection_name
get

The collection endpoint at which this object resides on the server.

Implements AnalyzeRe.IAPIResource.

Definition at line 37 of file Candidate.cs.

◆ constraints

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

The set of constraint function results for this candidate.

Definition at line 15 of file OptimizationResult.cs.

◆ feasible

bool AnalyzeRe.Optimization.OptimizationResult.feasible
getsetinherited

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.

◆ id

string AnalyzeRe.Optimization.Candidate.id
getset

The resource's unique identifier, used in the REST request URL when requesting the resource from the server.

Exceptions
ArgumentExceptionid should be a valid integer representation.

Implements AnalyzeRe.IAPIResource.

Definition at line 18 of file Candidate.cs.

◆ index

int? AnalyzeRe.Optimization.Candidate.index
getset

The index identifying this candidate within an OptimizationView's candidates.

Definition at line 54 of file Candidate.cs.

◆ objectives

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

The set of objective function results for this candidate.

Definition at line 11 of file OptimizationResult.cs.

◆ optimization_view

IReference<OptimizationView> AnalyzeRe.Optimization.Candidate.optimization_view
getset

The optimization view that owns this candidate.

Definition at line 50 of file Candidate.cs.

◆ parameterization

IEnumerable<CandidateParameter> AnalyzeRe.Optimization.Candidate.parameterization
getset

The parameters of the layer_views that define this candidate.

Definition at line 58 of file Candidate.cs.

◆ Path

string AnalyzeRe.Optimization.Candidate.Path
get

The relative path to this candidate from the root URL.

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 44 of file Candidate.cs.

◆ portfolio_view

SubResource<PortfolioView> AnalyzeRe.Optimization.Candidate.portfolio_view
get

An endpoint to request the portfolio_view that describes this candidate solution.

Definition at line 66 of file Candidate.cs.


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