C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Distributions.IDistribution Interface Reference

A distribution of values, used for parametric loss sets. More...

Public Member Functions

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

Properties

string collection_name [get]
 The relative path from the root of the API at which the collection of resources of this type reside.
 
DateTime? created [get, set]
 The date and time when the resource was created on the system.
 
string description [get, set]
 A user-friendly description of the resource.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
doublemax_val [get, set]
 The server calculated maximum value of this distribution (if available)
 
doublemean_val [get, set]
 The server calculated mean value of this distribution (if available)
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer.
 
doublemin_val [get, set]
 The server calculated minimum value of this distribution (if available)
 
DateTime? modified [get, set]
 The date and time when the resource was last modified on the system.
 
doublemodulo [get, set]
 Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified.
 
string Path [get]
 The relative path to this endpoint from the root URL.
 
string type [get]
 The server identifier for this resource's polymorphic sub-type.
 

Detailed Description

A distribution of values, used for parametric loss sets.

Definition at line 7 of file IDistribution.cs.

Inheritance diagram for AnalyzeRe.Distributions.IDistribution:
AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.Distribution AnalyzeRe.Distributions.IContinuousDistribution AnalyzeRe.Distributions.IDiscreteDistribution AnalyzeRe.Distributions.BinomialDistribution AnalyzeRe.Distributions.CustomDistribution AnalyzeRe.Distributions.DiracDistribution AnalyzeRe.Distributions.LogNormalDistribution AnalyzeRe.Distributions.NegativeBinomialDistribution AnalyzeRe.Distributions.NormalDistribution AnalyzeRe.Distributions.ParetoDistribution AnalyzeRe.Distributions.PoissonDistribution AnalyzeRe.Distributions.UniformDistribution AnalyzeRe.Distributions.UniformIntDistribution AnalyzeRe.Distributions.CustomDistribution AnalyzeRe.Distributions.DiracDistribution AnalyzeRe.Distributions.LogNormalDistribution AnalyzeRe.Distributions.NormalDistribution AnalyzeRe.Distributions.ParetoDistribution AnalyzeRe.Distributions.UniformDistribution AnalyzeRe.Distributions.BinomialDistribution AnalyzeRe.Distributions.CustomDistribution AnalyzeRe.Distributions.DiracDistribution AnalyzeRe.Distributions.NegativeBinomialDistribution AnalyzeRe.Distributions.PoissonDistribution AnalyzeRe.Distributions.UniformIntDistribution

Member Function Documentation

◆ ShallowCopy< T >()

T AnalyzeRe.IAPIType.ShallowCopy< T > ( )
inherited

Create a shallow copy of this object.

Returns
A shallow copy of this object.

Implemented in AnalyzeRe.APIType.

Type Constraints
T :IAPIType 

Property Documentation

◆ collection_name

◆ created

DateTime? AnalyzeRe.APITypes.IStoredAPIResource.created
getsetinherited

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

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 19 of file IStoredAPIResource.cs.

◆ description

string AnalyzeRe.APITypes.IStoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 14 of file IStoredAPIResource.cs.

◆ id

string AnalyzeRe.IAPIResource.id
getsetinherited

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

Implemented in AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.

Definition at line 14 of file IAPIResource.cs.

◆ max_val

double? AnalyzeRe.Distributions.IDistribution.max_val
getset

The server calculated maximum value of this distribution (if available)

Implemented in AnalyzeRe.Distribution.

Definition at line 28 of file IDistribution.cs.

◆ mean_val

double? AnalyzeRe.Distributions.IDistribution.mean_val
getset

The server calculated mean value of this distribution (if available)

Implemented in AnalyzeRe.Distribution.

Definition at line 24 of file IDistribution.cs.

◆ meta_data

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

Any user-defined metadata for this layer.

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 30 of file IStoredAPIResource.cs.

◆ min_val

double? AnalyzeRe.Distributions.IDistribution.min_val
getset

The server calculated minimum value of this distribution (if available)

Implemented in AnalyzeRe.Distribution.

Definition at line 20 of file IDistribution.cs.

◆ modified

DateTime? AnalyzeRe.APITypes.IStoredAPIResource.modified
getsetinherited

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

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 24 of file IStoredAPIResource.cs.

◆ modulo

double? AnalyzeRe.Distributions.IDistribution.modulo
getset

Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified.

Implemented in AnalyzeRe.Distribution.

Definition at line 16 of file IDistribution.cs.

◆ Path

string AnalyzeRe.APITypes.IEndpoint.Path
getinherited

The relative path to this endpoint from the root URL.

Implemented in AnalyzeRe.API.PortfolioViewMarginals, AnalyzeRe.APITypes.SubResourceEndpoint, AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.

Definition at line 13 of file IEndpoint.cs.

◆ type

string AnalyzeRe.APITypes.IAPI_Polymorphic.type
getinherited

The server identifier for this resource's polymorphic sub-type.

Implemented in AnalyzeRe.APITypes.APIType_Polymorphic, AnalyzeRe.APITypes.StoredAPIResource_Polymorphic, and AnalyzeRe.LayerView< T >.

Definition at line 10 of file IAPI_Polymorphic.cs.


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