Class RootFinderConfig

  • All Implemented Interfaces:
    Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

    public final class RootFinderConfig
    extends Object
    implements org.joda.beans.ImmutableBean, Serializable
    Configuration for the root finder used when calibrating curves.
    See Also:
    Serialized Form
    • Field Detail

      • DEFAULT_ABSOLUTE_TOLERANCE

        public static final double DEFAULT_ABSOLUTE_TOLERANCE
        The default absolute tolerance for the root finder.
        See Also:
        Constant Field Values
      • DEFAULT_RELATIVE_TOLERANCE

        public static final double DEFAULT_RELATIVE_TOLERANCE
        The default relative tolerance for the root finder.
        See Also:
        Constant Field Values
      • DEFAULT_MAXIMUM_STEPS

        public static final int DEFAULT_MAXIMUM_STEPS
        The default maximum number of steps for the root finder.
        See Also:
        Constant Field Values
    • Method Detail

      • standard

        public static RootFinderConfig standard()
        Returns standard root finder configuration, using the DEFAULT constants from this class.
        Returns:
        the standard root finder configuration, using the DEFAULT constants from this class
      • meta

        public static RootFinderConfig.Meta meta()
        The meta-bean for RootFinderConfig.
        Returns:
        the meta-bean, not null
      • builder

        public static RootFinderConfig.Builder builder()
        Returns a builder used to create an instance of the bean.
        Returns:
        the builder, not null
      • metaBean

        public RootFinderConfig.Meta metaBean()
        Specified by:
        metaBean in interface org.joda.beans.Bean
      • getAbsoluteTolerance

        public double getAbsoluteTolerance()
        Gets the absolute tolerance for the root finder.
        Returns:
        the value of the property
      • getRelativeTolerance

        public double getRelativeTolerance()
        Gets the relative tolerance for the root finder.
        Returns:
        the value of the property
      • getMaximumSteps

        public int getMaximumSteps()
        Gets the maximum number of steps for the root finder.
        Returns:
        the value of the property
      • toBuilder

        public RootFinderConfig.Builder toBuilder()
        Returns a builder that allows this bean to be mutated.
        Returns:
        the mutable builder, not null
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object