Package org.ddogleg.solver

Enum Class RootFinderType

java.lang.Object

java.lang.Enum<RootFinderType>

org.ddogleg.solver.RootFinderType

All Implemented Interfaces:

Serializable, Comparable<RootFinderType>, java.lang.constant.Constable

public enum RootFinderType
extends Enum<RootFinderType>

Types of polynomial root finding algorithms that can be used

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static RootFinderType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RootFinderType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null