Package nz.org.riskscape.engine.defaults.function

Class LossesByPeriod

java.lang.Object
nz.org.riskscape.engine.function.BaseRealizableFunction
nz.org.riskscape.engine.defaults.function.LossesByPeriod
All Implemented Interfaces:
nz.org.riskscape.engine.rl.RealizableFunction
public class LossesByPeriod extends nz.org.riskscape.engine.function.BaseRealizableFunction

Calculates loss metrics such as the Probable Maximum Loss (PML), Occurrence Exceedance Probability (OEP), and Aggregate Exceedance Probability (AEP). These loss metrics are all calculated in a similar way: return the nth largest loss out of the list. E.g. a 500-year RP for a 10,000 year investigation period will be the 20th largest loss (i.e. it's a 20-in-10000-year event or 10000 / 20 = 500 RP). The difference between PML, AEP, and OEP is how the list of losses gets aggregated. PML has no aggregation by year, AEP is the sum losses per year, and OEP is the max loss per year.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    LossesByPeriod.Mode
     
    static class 
    LossesByPeriod.Options
     

    Nested classes/interfaces inherited from interface nz.org.riskscape.engine.rl.RealizableFunction

    nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction

  • Field Summary

    Fields inherited from class nz.org.riskscape.engine.function.BaseRealizableFunction

    arguments, returnType

  • Constructor Summary

    Constructors
    Constructor
    Description
    LossesByPeriod()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.RiskscapeFunction>
    realize(nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.rl.ast.FunctionCall fc, List<nz.org.riskscape.engine.types.Type> givenTypes)
     

    Methods inherited from class nz.org.riskscape.engine.function.BaseRealizableFunction

    asFunction, build, builtin, getArguments, getReturnType, identified

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LossesByPeriod

      public LossesByPeriod()

  • Method Details

    • realize

      public nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.RiskscapeFunction> realize(nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.rl.ast.FunctionCall fc, List<nz.org.riskscape.engine.types.Type> givenTypes)
      Specified by:
      realize in interface nz.org.riskscape.engine.rl.RealizableFunction
      Overrides:
      realize in class nz.org.riskscape.engine.function.BaseRealizableFunction