Package uk.ac.rdg.resc.edal.grid

Interface RegularAxis

All Superinterfaces:

DiscreteDomain<Double,Extent<Double>>, Domain<Double>, ReferenceableAxis<Double>

All Known Implementing Classes:

RegularAxisImpl

public interface RegularAxis
extends ReferenceableAxis<Double>

A one-dimensional axis of a Grid, whose coordinate values are regularly spaced.

Author:

Jon Blower

Method Summary

Modifier and Type	Method	Description
int	findIndexOfUnconstrained(Double position)	Finds the apparent index of a given position, even if this is beyond the bounds of the axis.
double	getCoordinateSpacing()	Gets the spacing between coordinate values, might be negative.

Methods inherited from interface uk.ac.rdg.resc.edal.domain.DiscreteDomain

getDomainObjects

Methods inherited from interface uk.ac.rdg.resc.edal.domain.Domain

contains

Methods inherited from interface uk.ac.rdg.resc.edal.grid.ReferenceableAxis

equals, findIndexOf, getCoordinateBounds, getCoordinateExtent, getCoordinateValue, getCoordinateValues, getName, hashCode, isAscending, size, wraps

Method Detail

getCoordinateSpacing

double getCoordinateSpacing()

Gets the spacing between coordinate values, might be negative.

findIndexOfUnconstrained

int findIndexOfUnconstrained(Double position)
                      throws IllegalArgumentException

Finds the apparent index of a given position, even if this is beyond the bounds of the axis.

Parameters:

position - The position to test.

Returns:

The index where the position would appear, even if outside the bounds of this axis

Throws:

IllegalArgumentException - if the given position is null or Double.NaN