MonteCarloSettings.RuinFloor

property · MonteCarloSettings · cAlgo.API Since 5.10

DesktopCLICloud

Gets the equity level that is treated as account ruin. The risk of ruin is the share of the simulations whose equity drops to or below this level. It must be greater than or equal to 0 and the default value is 0.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

C#Python

public double RuinFloor {get; set;}

monteCarloSettings.RuinFloor: float

Returns double

Examples

C#Python

var monteCarlo = new MonteCarloSettings(MonteCarloMethod.Bootstrap, @"C:\Temp\montecarlo-result.json") { RuinFloor = 5000 };
Print("Account ruin level: {0}", monteCarlo.RuinFloor);

monteCarlo = MonteCarloSettings(MonteCarloMethod.Bootstrap, r"C:\Temp\montecarlo-result.json")
monteCarlo.RuinFloor = 5000
api.Print(f"Account ruin level: {monteCarlo.RuinFloor}")