Package nz.org.riskscape.engine.function

Class BaseMathsFunction

java.lang.Object
nz.org.riskscape.engine.function.BaseMathsFunction
All Implemented Interfaces:
AutoCloseable, nz.org.riskscape.engine.function.IdentifiedFunction, nz.org.riskscape.engine.function.RiskscapeFunction, nz.org.riskscape.engine.function.UntypedFunction, nz.org.riskscape.engine.Identified
Direct Known Subclasses:
Abs, Log, Log10, LogNormalCurveFunction, NormalCurveFunction, OverloadedAggregatingMathsFunction, Polynomial, Pow, Scale
public abstract class BaseMathsFunction extends Object implements nz.org.riskscape.engine.function.IdentifiedFunction

Convenience class with built in support for integer and floating point modes and everything in between

  • Nested Class Summary

    Nested classes/interfaces inherited from interface nz.org.riskscape.engine.function.IdentifiedFunction

    nz.org.riskscape.engine.function.IdentifiedFunction.Category, nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    description
     

    Fields inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

    BUILT_IN, LOG

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseMathsFunction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    call(List<Object> args)
     
    nz.org.riskscape.engine.function.IdentifiedFunction.Category
    getCategory()
     
    String
    getDescription()
     
    String
    getId()
     
    URI
    getSourceURI()
     
    protected nz.org.riskscape.engine.function.RiskscapeFunction
    wrapping(nz.org.riskscape.engine.function.ArgumentList args)
     
    protected nz.org.riskscape.engine.function.RiskscapeFunction
    wrapping(nz.org.riskscape.engine.function.FunctionArgument... newArgs)
     
    protected nz.org.riskscape.engine.function.RiskscapeFunction
    wrapping(nz.org.riskscape.engine.types.Type... newTypes)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface nz.org.riskscape.engine.Identified

    getIdentifiedClass

    Methods inherited from interface nz.org.riskscape.engine.function.IdentifiedFunction

    getSource, infoOutput, isBuiltin, toEntity

    Methods inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

    builtin, close, getAggregationFunction, getArguments, getArgumentTypes, getOverloaded, getRealizable, getReturnType, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

  • Field Details

    • description

      protected String description

  • Constructor Details

    • BaseMathsFunction

      public BaseMathsFunction()

  • Method Details

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface nz.org.riskscape.engine.function.IdentifiedFunction

    • call

      public Object call(List<Object> args)
      Specified by:
      call in interface nz.org.riskscape.engine.function.UntypedFunction

    • getCategory

      public nz.org.riskscape.engine.function.IdentifiedFunction.Category getCategory()
      Specified by:
      getCategory in interface nz.org.riskscape.engine.function.IdentifiedFunction

    • getSourceURI

      public URI getSourceURI()
      Specified by:
      getSourceURI in interface nz.org.riskscape.engine.function.IdentifiedFunction

    • wrapping

      protected nz.org.riskscape.engine.function.RiskscapeFunction wrapping(nz.org.riskscape.engine.types.Type... newTypes)

    • wrapping

      protected nz.org.riskscape.engine.function.RiskscapeFunction wrapping(nz.org.riskscape.engine.function.FunctionArgument... newArgs)

    • wrapping

      protected nz.org.riskscape.engine.function.RiskscapeFunction wrapping(nz.org.riskscape.engine.function.ArgumentList args)

    • getId

      public String getId()
      Specified by:
      getId in interface nz.org.riskscape.engine.Identified