org.ddogleg.solver

Enum RootFinderType

java.lang.Object

java.lang.Enum<RootFinderType>

org.ddogleg.solver.RootFinderType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RootFinderType>

public enum RootFinderType
extends java.lang.Enum<RootFinderType>

Types of polynomial root finding algorithms that can be used

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVD Eigenvalue decomposition based.
STURM Uses Sturm sequences to find roots.

Method Summary

Modifier and Type	Method and Description
static RootFinderType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RootFinderType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVD

public static final RootFinderType EVD

Eigenvalue decomposition based. Returns real and complex roots. Most accurate but slightly slower.

STURM

public static final RootFinderType STURM

Uses Sturm sequences to find roots. Only real roots and the fastest algorithm, but slightly less accurate.

Method Detail

values

public static RootFinderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RootFinderType c : RootFinderType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RootFinderType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null