com.hedgehog.math.functions
Class Function

java.lang.Object
  com.hedgehog.HObject
      com.hedgehog.math.functions.Function

All Implemented Interfaces:

java.lang.Comparable, java.util.Comparator

Direct Known Subclasses:

AssociatedLegendrePolynomialFunction, BernsteinPolynomialFunction, BesselFunction, BivariateRationalBernsteinPolynomialFunction, BivariateRationalBSplinePolynomialFunction, BSplinePolynomialFunction, ChebyshevPolynomialFunction, LegendrePolynomialFunction, LogarithmicIntegralFunction, NVariableFunction, OneVariableDoubleVector3DFunction, OneVariableFunction, OneVariableVector2DFunction, OneVariableVector3DFunction, RationalBernsteinPolynomialFunction, TwoVariableFunction, TwoVariableVector3DFunction, XYVectorPolynomialFunction

public abstract class Function
extends HObject

Title: Function - abstract base class function hierarchy.

Description: Abstract base class of function classes.

Copyright: Copyright (c) Hedgehog Software 2007-2009.

Company: Hedgehog Software

Since:

1.0

Version:

1.1

Field Summary

protected java.lang.reflect.Method

method Operated-on function.

Fields inherited from class com.hedgehog.HObject

mID, mName

Constructor Summary

Function()
Default constructor.

Function(Function object)
Copy constructor.

Function(java.lang.reflect.Method method)

Method Summary

java.lang.reflect.Method	getMethod() Returns the method.
abstract boolean	isValid() Tests whether or not a valid object.
boolean	setMethod(java.lang.reflect.Method newMethod) Sets the method.
java.lang.String	toString() Returns a String representation of a Function object.

Methods inherited from class com.hedgehog.HObject

clone, compare, compareTo, copy, equals, getID, getName, hashCode, hasID, hasName, setID, setName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

method

protected java.lang.reflect.Method method

Operated-on function.

Constructor Detail

Function

public Function()

Default constructor. Sets the method to null.

Function

public Function(java.lang.reflect.Method method)

Parameters:

method - Function operated-on.

Throws:

java.lang.IllegalArgumentException - Thrown if a null method is supplied.

Function

public Function(Function object)

Copy constructor.

Parameters:

object - Object to copy.

Method Detail

getMethod

public java.lang.reflect.Method getMethod()

Returns the method.

Returns:

The method.

setMethod

public boolean setMethod(java.lang.reflect.Method newMethod)

Sets the method.

Parameters:

newMethod - Sets the method.

Returns:

Logical-true if the method is set, else logical-false if either newMethod is null or invalid according to isValid().

toString

public java.lang.String toString()

Returns a String representation of a Function object.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of a Function object.

isValid

public abstract boolean isValid()

Tests whether or not a valid object.

Returns:

Logical-true if a valid object, else logical-false.