org.xmlcml.euclid

Class RealRangeArray

java.lang.Object

org.xmlcml.euclid.RealRangeArray

All Implemented Interfaces:

Iterable<RealRange>

public class RealRangeArray
extends Object
implements Iterable<RealRange>

holds an array of RealRanges may or may not overlap or be sorted perhaps replace by Google rangeSet of IntervalTree later

Author:

pm286

Constructor Summary

Constructors

Constructor and Description
RealRangeArray()
RealRangeArray(List<Real2Range> r2rList, RealRange.Direction dir)
RealRangeArray(List<RealRange> rangeList)
RealRangeArray(Real2Range textBox, RealRange.Direction direction)
RealRangeArray(RealRangeArray array) deep copy

Method Summary

Modifier and Type	Method and Description
void	add(RealRange range)
void	addCaps(Real2Range r2r)
void	addCaps(Real2Range r2r, RealRange.Direction dir)
void	addTerminatingCaps(Double xmin, Double xmax) add virtual ends to the array
void	debug()
boolean	equals(Object obj)
void	extendRangesBy(double tolerance) adds tolerance to ends of ranges see realRange.extendsRangesBy() for positive and negative tolerance if result means ranges overlap, takes the mean
void	format(int decimalPlaces)
RealRange	get(int serial)
RealArray	getGaps()
int	hashCode()
boolean	includes(RealRange rr) is the range completely contained within any subrange?
RealRangeArray	inverse() create array representing the gaps in this gaps at ends are NOT filled does not alter this
Iterator<RealRange>	iterator()
RealRangeArray	plus(RealRangeArray array)
void	removeLessThan(double rangeMin) remove small ranges (e.g.
void	setDirection(RealRange.Direction direction)
int	size()
void	sort()
void	sortAndRemoveOverlapping() sort ranges into order and merge overlapping ones
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RealRangeArray

public RealRangeArray()

RealRangeArray

public RealRangeArray(RealRangeArray array)

deep copy

Parameters:

array -

RealRangeArray

public RealRangeArray(List<Real2Range> r2rList,
                      RealRange.Direction dir)

RealRangeArray

public RealRangeArray(List<RealRange> rangeList)

RealRangeArray

public RealRangeArray(Real2Range textBox,
                      RealRange.Direction direction)

Method Detail

add

public void add(RealRange range)

sort

public void sort()

sortAndRemoveOverlapping

public void sortAndRemoveOverlapping()

sort ranges into order and merge overlapping ones

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

size

public int size()

get

public RealRange get(int serial)

debug

public void debug()

plus

public RealRangeArray plus(RealRangeArray array)

inverse

public RealRangeArray inverse()

create array representing the gaps in this gaps at ends are NOT filled does not alter this

Returns:

iterator

public Iterator<RealRange> iterator()

Specified by:

iterator in interface Iterable<RealRange>

addCaps

public void addCaps(Real2Range r2r)

addCaps

public void addCaps(Real2Range r2r,
                    RealRange.Direction dir)

addTerminatingCaps

public void addTerminatingCaps(Double xmin,
                               Double xmax)

add virtual ends to the array

Parameters:

xmin -

xmax -

removeLessThan

public void removeLessThan(double rangeMin)

remove small ranges (e.g. between characters)

Parameters:

rangeMin -

includes

public boolean includes(RealRange rr)

is the range completely contained within any subrange?

Parameters:

rr -

Returns:

setDirection

public void setDirection(RealRange.Direction direction)

toString

public String toString()

Overrides:

toString in class Object

format

public void format(int decimalPlaces)

getGaps

public RealArray getGaps()

extendRangesBy

public void extendRangesBy(double tolerance)

adds tolerance to ends of ranges see realRange.extendsRangesBy() for positive and negative tolerance if result means ranges overlap, takes the mean

Parameters:

tolerance -