Interface ParameterDriversProvider

    • Method Detail

      • getParametersDrivers

        List<ParameterDriver> getParametersDrivers()
        Get the drivers for parameters.
        Returns:
        drivers for parameters
      • getNbParametersDriversValue

        default int getNbParametersDriversValue()
        Get total number of spans for all the parameters driver.
        Returns:
        total number of span to be estimated
        Since:
        12.0
      • getParameters

        default double[] getParameters()
        Get model parameters.
        Returns:
        model parameters, will throw an exception if one PDriver has several values driven. If it's the case (if at least 1 PDriver of the model has several values driven) the method getParameters(AbsoluteDate) must be used.
        Since:
        12.0
      • getParameters

        default double[] getParameters​(AbsoluteDate date)
        Get model parameters.
        Parameters:
        date - date at which the parameters want to be known, can be new AbsoluteDate() if all the parameters have no validity period that is to say that they have only 1 estimated value over the all interval
        Returns:
        model parameters
        Since:
        12.0
      • getParametersAllValues

        default double[] getParametersAllValues()
        Get model parameters, return a list a all span values of all parameters.
        Returns:
        model parameters
        Since:
        12.0
      • getParametersAllValues

        default <T extends CalculusFieldElement<T>> T[] getParametersAllValues​(Field<T> field)
        Get model parameters.
        Type Parameters:
        T - type of the elements
        Parameters:
        field - field to which the elements belong
        Returns:
        model parameters
        Since:
        9.0
      • getParameters

        default <T extends CalculusFieldElement<T>> T[] getParameters​(Field<T> field)
        Get model parameters.
        Type Parameters:
        T - type of the elements
        Parameters:
        field - field to which the elements belong
        Returns:
        model parameters, will throw an exception if one PDriver of the has several values driven. If it's the case (if at least 1 PDriver of the model has several values driven) the method getParameters(Field, FieldAbsoluteDate) must be used.
        Since:
        9.0
      • getParameters

        default <T extends CalculusFieldElement<T>> T[] getParameters​(Field<T> field,
                                                                      FieldAbsoluteDate<T> date)
        Get model parameters.
        Type Parameters:
        T - type of the elements
        Parameters:
        field - field to which the elements belong
        date - field date at which the parameters want to be known, can be new AbsoluteDate() if all the parameters have no validity period.
        Returns:
        model parameters
        Since:
        9.0
      • getParameterDriver

        default ParameterDriver getParameterDriver​(String name)
        Get parameter value from its name.
        Parameters:
        name - parameter name
        Returns:
        parameter value
        Since:
        8.0
      • isSupported

        default boolean isSupported​(String name)
        Check if a parameter is supported.

        Supported parameters are those listed by getParametersDrivers().

        Parameters:
        name - parameter name to check
        Returns:
        true if the parameter is supported
        Since:
        8.0
        See Also:
        getParametersDrivers()