fr.cnes.sirius.patrius.math.analysis.polynomials

Enum PolynomialType

java.lang.Object

java.lang.Enum<PolynomialType>

fr.cnes.sirius.patrius.math.analysis.polynomials.PolynomialType

All Implemented Interfaces:

Serializable, Comparable<PolynomialType>

public enum PolynomialType
extends Enum<PolynomialType>

Describe the polynomial function type.

Since:

4.11

Version:

$Id$

Author:

Thibaut BONIT

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHEBYSHEV Chebyshev polynomial function.
CLASSICAL Classical polynomial function.

Method Summary

Modifier and Type	Method and Description
String	getNature() Getter for the nature of the polynomial function.
static PolynomialType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PolynomialType[]	values() 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 Detail

CLASSICAL

public static final PolynomialType CLASSICAL

Classical polynomial function.

CHEBYSHEV

public static final PolynomialType CHEBYSHEV

Chebyshev polynomial function.

Method Detail

values

public static PolynomialType[] 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 (PolynomialType c : PolynomialType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PolynomialType 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

getNature

public String getNature()

Getter for the nature of the polynomial function.

Returns:

the nature of the polynomial function