Enum LMA.Mode

java.lang.Object
java.lang.Enum<LMA.Mode>
org.bzdev.math.LMA.Mode
All Implemented Interfaces:
Serializable, Comparable<LMA.Mode>
Enclosing class:
LMA

public static enum LMA.Mode extends Enum<LMA.Mode>
The mode determining how a sum of squares is calculated.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    The first argument will not be passed to the real-valued function and instead will be used as values yi.
    The sum of the squares of values of a real-valued function will be minimized.
    The first two arguments will not be passed to the real-valued function and instead the first will be used as values yi, and the second as values σi The terms that are squared and summed are (yi - fi)/σi, where fi is the value of the real value function applied to the remaining arguments and parameters.
  • Method Summary

    Modifier and Type
    Method
    Description
    static LMA.Mode
    Returns the enum constant of this type with the specified name.
    static LMA.Mode[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • NORMAL

      public static final LMA.Mode NORMAL
      The sum of the squares of values of a real-valued function will be minimized.
    • LEAST_SQUARES

      public static final LMA.Mode LEAST_SQUARES
      The first argument will not be passed to the real-valued function and instead will be used as values yi. The terms that are squared and summed are yi - fi, where fi is the value of the real value function applied to the remaining arguments and parameters.
    • WEIGHTED_LEAST_SQUARES

      public static final LMA.Mode WEIGHTED_LEAST_SQUARES
      The first two arguments will not be passed to the real-valued function and instead the first will be used as values yi, and the second as values σi The terms that are squared and summed are (yi - fi)/σi, where fi is the value of the real value function applied to the remaining arguments and parameters.
  • Method Details

    • values

      public static LMA.Mode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static LMA.Mode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null