C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
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.
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. | |
int? | index [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< OptimizationView > | optimization_view [get, set] |
The optimization view that owns this candidate. | |
IEnumerable< CandidateParameter > | parameterization [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< PortfolioView > | portfolio_view [get] |
An endpoint to request the portfolio_view that describes this candidate solution. | |
A candidate is a potential solution to the optimization problem.
Definition at line 10 of file Candidate.cs.
|
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.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
|
get |
The collection endpoint at which this object resides on the server.
Implements AnalyzeRe.IAPIResource.
Definition at line 37 of file Candidate.cs.
|
getsetinherited |
The set of constraint function results for this candidate.
Definition at line 15 of file OptimizationResult.cs.
|
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.
|
getset |
The resource's unique identifier, used in the REST request URL when requesting the resource from the server.
ArgumentException | id should be a valid integer representation. |
Implements AnalyzeRe.IAPIResource.
Definition at line 18 of file Candidate.cs.
|
getset |
The index identifying this candidate within an OptimizationView's candidates.
Definition at line 54 of file Candidate.cs.
|
getsetinherited |
The set of objective function results for this candidate.
Definition at line 11 of file OptimizationResult.cs.
|
getset |
The optimization view that owns this candidate.
Definition at line 50 of file Candidate.cs.
|
getset |
The parameters of the layer_views that define this candidate.
Definition at line 58 of file Candidate.cs.
|
get |
The relative path to this candidate from the root URL.
The relative path to this endpoint from the root URL.
System.ArgumentException | If this resource does not have an id. |
Implements AnalyzeRe.APITypes.IEndpoint.
Definition at line 44 of file Candidate.cs.
|
get |
An endpoint to request the portfolio_view that describes this candidate solution.
Definition at line 66 of file Candidate.cs.