C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Optimization.OptimizationView Class Reference

Representation of a set of Optimization Parameters. More...

Public Member Functions

 OptimizationView ()
 Construct a new OptimizationView with empty domain and custom_parameters lists. More...
 
PortfolioView GetCandidatePortfolioView (int candidateIndex, int?timeout_ms=null)
 Retrieves a PortfolioView corresponding to the specified candidate portfolio result, built using the analysis_profile used in this optimization run and the domain layers with modifications suggested in this candidate. More...
 
Candidate GetCandidateResult (int candidateIndex, int?timeout_ms=null)
 Retrieves the specified candidate portfolio result, which contains its metrics (objective, constraint, and feasibility results) and parameterization describing how the domain layers can be modified to produce this candidate. More...
 
long GetCandidateResultsCount (int?timeout_ms=null)
 Retrieves the number of candidate results produced by this optimization run. Note that you can also get the results count from the ICollectionResponse<CandidateResult>.meta. CollectionResponseMeta.total_count property while paging through the candidates sub-collection. More...
 
OptimizationResult GetInitialPortfolioMetrics (int?timeout_ms=null)
 Retrieves the initial portfolio metrics, which contain the objective, constraint, and feasibility results for the portfolio built using the supplied domain layers without any modifications. More...
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 

Public Attributes

Candidates candidates => _candidates ?? (_candidates = new Candidates(this))
 A collection of optimization result from this Optimization run. Will return a 503 with a Retry-After if results are not yet ready. Has methods for retrieving a paginated list of candidates, or a specific candidate. More...
 
override string collection_name => CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 
DataSubResource csv => _csv ?? (_csv = new DataSubResource(this, "csv"))
 Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated. More...
 
SubResource< OptimizationResultinitial_portfolio_result
 Once this optimization's run has completed, this will contain the objective, constraint, and feasibility metrics' results for the initial portfolio, as determined by the initial shares assigned to all domain layers. Will return a 503 with a Retry-After if not ready More...
 
SubResource< CandidateResultsListresult
 Get the result of this OptimizationView. Will return a 503 with a Retry-After if not ready. More...
 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "optimization_views"
 The collection endpoint at which resources of this type reside on the server. More...
 

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. More...
 

Properties

IReference< AnalysisProfileanalysis_profile [get, set]
 The optimizations's analysis profile. More...
 
DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
Dictionary< string, object > custom_parameters [get, set]
 A key/value pair dictionary of additional parameters taken by the optimization function. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
List< DomainEntrydomains [get, set]
 The list of layers to be optimized and their min/max constraints. More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
Dictionary< string, double > initial_portfolio_metrics [get, set]
 Once this optimization's run has completed, this will contain the objective metrics' results for the initial portfolio, as determined by the initial shares assigned to all domain layers. More...
 
int iterations [get, set]
 The maximum number of iterations to perform during the optimization. More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
int population_size [get, set]
 The population size to use in the optimization. More...
 
double progress [get, set]
 The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 
string target_currency [get, set]
 The currency that this optimization's results should be returned in. More...
 

Detailed Description

Representation of a set of Optimization Parameters.

Definition at line 12 of file OptimizationView.cs.

Inheritance diagram for AnalyzeRe.Optimization.OptimizationView:
AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.IAPIAnalysis AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

AnalyzeRe.Optimization.OptimizationView.OptimizationView ( )
inline

Construct a new OptimizationView with empty domain and custom_parameters lists.

Definition at line 117 of file OptimizationView.cs.

Member Function Documentation

override void AnalyzeRe.Optimization.OptimizationView.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.

Reimplemented from AnalyzeRe.APIType.

Definition at line 124 of file OptimizationView.cs.

PortfolioView AnalyzeRe.Optimization.OptimizationView.GetCandidatePortfolioView ( int  candidateIndex,
int?  timeout_ms = null 
)
inline

Retrieves a PortfolioView corresponding to the specified candidate portfolio result, built using the analysis_profile used in this optimization run and the domain layers with modifications suggested in this candidate.

Parameters
candidateIndexThe zero-based index of the candidate portfolio result to retrieve for this optimization_view.
timeout_msOptional - The desired request timeout (in milliseconds).

Definition at line 156 of file OptimizationView.cs.

Candidate AnalyzeRe.Optimization.OptimizationView.GetCandidateResult ( int  candidateIndex,
int?  timeout_ms = null 
)

Retrieves the specified candidate portfolio result, which contains its metrics (objective, constraint, and feasibility results) and parameterization describing how the domain layers can be modified to produce this candidate.

Parameters
candidateIndexThe zero-based index of the candidate portfolio result to retrieve for this optimization_view.
timeout_msOptional - The desired request timeout (in milliseconds).
long AnalyzeRe.Optimization.OptimizationView.GetCandidateResultsCount ( int?  timeout_ms = null)

Retrieves the number of candidate results produced by this optimization run. Note that you can also get the results count from the ICollectionResponse<CandidateResult>.meta. CollectionResponseMeta.total_count property while paging through the candidates sub-collection.

Parameters
timeout_msOptional - The desired request timeout (in milliseconds).
OptimizationResult AnalyzeRe.Optimization.OptimizationView.GetInitialPortfolioMetrics ( int?  timeout_ms = null)

Retrieves the initial portfolio metrics, which contain the objective, constraint, and feasibility results for the portfolio built using the supplied domain layers without any modifications.

Parameters
timeout_msOptional - The desired request timeout (in milliseconds).
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.

Member Data Documentation

Candidates AnalyzeRe.Optimization.OptimizationView.candidates => _candidates ?? (_candidates = new Candidates(this))

A collection of optimization result from this Optimization run. Will return a 503 with a Retry-After if results are not yet ready. Has methods for retrieving a paginated list of candidates, or a specific candidate.

Definition at line 76 of file OptimizationView.cs.

readonly string AnalyzeRe.Optimization.OptimizationView.CLASS_COLLECTION_NAME = "optimization_views"
static

The collection endpoint at which resources of this type reside on the server.

Definition at line 16 of file OptimizationView.cs.

override string AnalyzeRe.Optimization.OptimizationView.collection_name => CLASS_COLLECTION_NAME

The collection endpoint at which resources of this type reside on the server.

Definition at line 20 of file OptimizationView.cs.

DataSubResource AnalyzeRe.Optimization.OptimizationView.csv => _csv ?? (_csv = new DataSubResource(this, "csv"))

Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated.

Definition at line 81 of file OptimizationView.cs.

SubResource<OptimizationResult> AnalyzeRe.Optimization.OptimizationView.initial_portfolio_result
Initial value:
=> _initialPortfolioResult ??
(_initialPortfolioResult = new SubResource<OptimizationResult>(this, "initial_portfolio_metrics"))

Once this optimization's run has completed, this will contain the objective, constraint, and feasibility metrics' results for the initial portfolio, as determined by the initial shares assigned to all domain layers. Will return a 503 with a Retry-After if not ready

Definition at line 88 of file OptimizationView.cs.

SubResource<CandidateResultsList> AnalyzeRe.Optimization.OptimizationView.result
Initial value:
=> new SubResource<CandidateResultsList>(this, "result")
{
DefaultTimeout = API.DefaultRequestTimeoutCollections
}

Get the result of this OptimizationView. Will return a 503 with a Retry-After if not ready.

Definition at line 108 of file OptimizationView.cs.

Property Documentation

IReference<AnalysisProfile> AnalyzeRe.Optimization.OptimizationView.analysis_profile
getset

The optimizations's analysis profile.

Definition at line 39 of file OptimizationView.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

The date and time when the resource was created on the system.

Definition at line 19 of file StoredAPIResource.cs.

Dictionary<string, object> AnalyzeRe.Optimization.OptimizationView.custom_parameters
getset

A key/value pair dictionary of additional parameters taken by the optimization function.

Definition at line 52 of file OptimizationView.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

List<DomainEntry> AnalyzeRe.Optimization.OptimizationView.domains
getset

The list of layers to be optimized and their min/max constraints.

Definition at line 45 of file OptimizationView.cs.

string AnalyzeRe.APIResource.id
getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Definition at line 16 of file APIResource.cs.

Dictionary<string, double> AnalyzeRe.Optimization.OptimizationView.initial_portfolio_metrics
getset

Once this optimization's run has completed, this will contain the objective metrics' results for the initial portfolio, as determined by the initial shares assigned to all domain layers.

Definition at line 100 of file OptimizationView.cs.

int AnalyzeRe.Optimization.OptimizationView.iterations
getset

The maximum number of iterations to perform during the optimization.

Definition at line 28 of file OptimizationView.cs.

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data
getsetinherited

Any user-defined metadata for this layer.

Definition at line 30 of file StoredAPIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

The date and time when the resource was last modified on the system.

Definition at line 24 of file StoredAPIResource.cs.

int AnalyzeRe.Optimization.OptimizationView.population_size
getset

The population size to use in the optimization.

Definition at line 34 of file OptimizationView.cs.

double AnalyzeRe.APITypes.StoredAPIResource_WithStatus.progress
getsetinherited

The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types.

Definition at line 28 of file StoredAPIResource_WithStatus.cs.

TaskStatus AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status
getsetinherited

Status of the data file associated with this resource.

Definition at line 16 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status_message
getsetinherited

Status message of the data file associated with this resource.

Definition at line 21 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.Optimization.OptimizationView.target_currency
getset

The currency that this optimization's results should be returned in.

At this time all layer terms and domain target currencies must match this value.

Definition at line 58 of file OptimizationView.cs.


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