Function GMP::Stochastic::GetRepresentativeScenario(GMP, stage, scenario)

GMP::Stochastic::GetRepresentativeScenario

The function GMP::Stochastic::GetRepresentativeScenario returns the representive scenario of a scenario at some stage in the scenario tree belonging to a stochastic mathematical program.

GMP::Stochastic::GetRepresentativeScenario(
     GMP,            ! (input) a generated mathematical program
     stage,          ! (input) a scalar reference
     scenario        ! (input) a scenario
)

Arguments

GMP

An element in the set AllGeneratedMathematicalPrograms.

stage

An integer scalar reference to a stage.

scenario

An element in the set AllStochasticScenarios.

Return Value

An element in the set AllStochasticScenarios.

Note

The GMP should have been created by the function GMP::Instance::GenerateStochasticProgram.

See also

The routines GMP::Instance::GenerateStochasticProgram and GMP::Stochastic::GetRelativeWeight. See Basic Concepts of the Language Reference for more details on scenario tree, scenarios and stages.