com.mockturtlesolutions.snifflib.invprobs

Class Dbracket

java.lang.Object

com.mockturtlesolutions.snifflib.invprobs.Dbracket

Direct Known Subclasses:

Polint

public class Dbracket
extends java.lang.Object

Class useful for finding and returning bracketing sets for sorted vectors. The data on which the bracketing is performed is only pointed to. Changes in the input data outside of this class may produce unexpected results. Algorithm based on the hunt and locate algorithms of Numerical Recipes in Fortran, Press et al pp 110-113.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	CurrentIndex
protected DblMatrix	X

Constructor Summary

Constructors

Constructor and Description
Dbracket(DblMatrix X) Construct a bracketing

Method Summary

Methods

Modifier and Type	Method and Description
int[]	bracket(DblMatrix xx) Find a bracketing interval about a given data point.
int[]	getCenteredIndexWindow(int m) Return a window of m points centered about the CurrentIndex.
int[]	getCenteredIndexWindow(int j, int m) Return a window of m points centered about index k.
int[]	getCenteredWindow(DblMatrix xx, int m) Return a window of m points centered about the value X.
int	getCurrentIndex() Return the current starting index for the search.
int	getTotalDataCount()
int[]	hunt(DblMatrix xx) Return a single index bracket of a scalar X.
void	setCurrentIndex(int v) Set the current starting index for the search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

X

protected DblMatrix X

CurrentIndex

protected int CurrentIndex

Constructor Detail

Dbracket

public Dbracket(DblMatrix X)

Construct a bracketing

Method Detail

getTotalDataCount

public int getTotalDataCount()

getCurrentIndex

public int getCurrentIndex()

Return the current starting index for the search.

setCurrentIndex

public void setCurrentIndex(int v)

Set the current starting index for the search.

bracket

public int[] bracket(DblMatrix xx)

Find a bracketing interval about a given data point.

hunt

public int[] hunt(DblMatrix xx)

Return a single index bracket of a scalar X. The condition attained is that B[0] <= X <= B[1] If X is less than the lowest value then a B[0] = -1 or if X is greater than the highest value then B[1] = N where N is the number of values. In either case the index is invalid.

getCenteredWindow

public int[] getCenteredWindow(DblMatrix xx,
                      int m)

Return a window of m points centered about the value X. If the point lies below the lowest data point the first element of the window will be equal to Integer.MIN_VALUE. Similarly, if the point lies above the maximum data element then the second element will be Integer.MAX_VALUE.

getCenteredIndexWindow

public int[] getCenteredIndexWindow(int j,
                           int m)

Return a window of m points centered about index k.

getCenteredIndexWindow

public int[] getCenteredIndexWindow(int m)

Return a window of m points centered about the CurrentIndex.