org.das2.datum

Class LogDomainDivider

java.lang.Object

org.das2.datum.LogDomainDivider

All Implemented Interfaces:

DomainDivider

public class LogDomainDivider
extends java.lang.Object
implements DomainDivider

A DomainDivider to divide a range into (base 10) logarithmically equal segments.

Field Summary

Fields inherited from interface org.das2.datum.DomainDivider

MAX_BOUNDARIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogDomainDivider()

Method Summary

Modifier and Type	Method and Description
DatumVector	boundaries(Datum min, Datum max) Returns the boundaries between intervals on the given data range.
long	boundaryCount(Datum min, Datum max) Compute the number of intervals produced by this DomainDivider on the given range.
DomainDivider	coarserDivider(boolean superset) Return a new divider with larger intervals.
DomainDivider	finerDivider(boolean superset) Return a new divider with smaller intervals.
static void	main(java.lang.String[] args)
DatumRange	rangeContaining(Datum v) Return a DatumRange representing the interval containing the given value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogDomainDivider

protected LogDomainDivider()

Method Detail

coarserDivider

public DomainDivider coarserDivider(boolean superset)

Description copied from interface: DomainDivider

Return a new divider with larger intervals. If the superset parameter is true, the interval boundaries of the new divider are guaranteed to align with (some) interval boundaries of the existing one. In other words, the existing divider will subdivide the new one.

Specified by:

coarserDivider in interface DomainDivider

Parameters:

superset - true to force boundary alignment with the calling DomainDivider. For a given range, the boundaries will be aligned.

Returns:

the new DomainDivider object

finerDivider

public DomainDivider finerDivider(boolean superset)

Description copied from interface: DomainDivider

Return a new divider with smaller intervals. If the superset parameter is true, the interval boundaries of the existing divider are guaranteed to align with (some) intervals of the new one. In other words, the new divider will subdivide the existing one.

Specified by:

finerDivider in interface DomainDivider

Parameters:

superset - true to force boundary alignment with the calling DomainDivider For a given range, the boundaries will be aligned.

Returns:

the new DomainDivider object

boundaries

public DatumVector boundaries(Datum min,
                              Datum max)

Description copied from interface: DomainDivider

Returns the boundaries between intervals on the given data range. When min or max lay on a boundary, it should be returned. Note this is inconsistent with DatumRange logic, where the max is exclusive. If min>&eq;max, then an empty list should be returned.

Specified by:

boundaries in interface DomainDivider

Parameters:

min - the lower bound

max - the upper bound

Returns:

a DatumVector containing the boundary values

boundaryCount

public long boundaryCount(Datum min,
                          Datum max)

Description copied from interface: DomainDivider

Compute the number of intervals produced by this DomainDivider on the given range. This allows the DomainDivider to indicate the number of intervals (e.g. a zillion) without having to enumerate them. When min or max lay on a boundary, it should be counted (inclusive max). If min>&eq;max, then zero should be returned.

Specified by:

boundaryCount in interface DomainDivider

Returns:

rangeContaining

public DatumRange rangeContaining(Datum v)

Description copied from interface: DomainDivider

Return a DatumRange representing the interval containing the given value.

Specified by:

rangeContaining in interface DomainDivider

Returns:

the range containing a given value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

main

public static void main(java.lang.String[] args)