Range (MiLib 1.8.3 API)

java.lang.Object
- com.milaboratory.core.Range

All Implemented Interfaces:

Serializable, Comparable<Range>
```
public final class Range
extends Object
implements Serializable, Comparable<Range>
```
This class represents a range of positions in a sequence (e.g. sub-sequence). Range can be reversed (from > to), to represent reverse complement sub-sequence of a nucleotide sequence.
Main contract: upper limit (with biggest value) is always exclusive, and lower is always inclusive.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Comparator<Range> COMPARATOR_BY_FROM

Fields
Modifier and Type	Field and Description
`static Comparator<Range>`	`COMPARATOR_BY_FROM`

Constructor Summary

Constructors
Constructor and Description

Range(int from, int to)

Range(int lower, int upper, boolean reversed)

Constructors
Constructor and Description
`Range(int from, int to)`
`Range(int lower, int upper, boolean reversed)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Range o)`
`boolean`	`contains(int position)` Returns `true` if range contains provided `position`.
`boolean`	`contains(Range other)` Returns `true` if range contains `other` range.
`boolean`	`containsBoundary(int position)`
`int[]`	`convertBoundariesToRelativePosition(int... absolutePositions)`
`int`	`convertBoundaryToAbsolutePosition(int relativePosition)` Converts relative boundary position to absolute position
`int`	`convertBoundaryToRelativePosition(int absolutePosition)` Returns relative boundary position inside this range.
`int[]`	`convertPointsToRelativePosition(int... absolutePositions)`
`int`	`convertPointToAbsolutePosition(int relativePosition)` Converts relative point position to absolute position
`int`	`convertPointToRelativePosition(int absolutePosition)` Returns relative point position inside this range.
`boolean`	`equals(Object o)`
`Range`	`expand(int offset)`
`Range`	`expand(int leftOffset, int rightOffset)`
`Range`	`getAbsoluteRangeFor(Range relativeRange)` Reverse operation for `getRelativeRangeOf(Range)`.
`int`	`getFrom()` Returns from value.
`int`	`getLower()` Returns lower (with least value) bound of this range.
`Range`	`getRelativeRangeOf(Range absoluteRange)`
`int`	`getTo()` Returns to value.
`int`	`getUpper()` Returns upper (with biggest value) bound of this range.
`int`	`hashCode()`
`boolean`	`hasSameDirection(Range other)` Returns true if two ranges has the same direction.
`Range`	`intersection(Range other)` Returns intersection range with `other` range.
`Range`	`intersectionWithTouch(Range other)` Returns intersection range with `other` range.
`boolean`	`intersectsWith(Range other)` Returns `true` if range intersects with `other` range.
`boolean`	`intersectsWithOrTouches(Range other)` Returns `true` if range intersects with or touches `other` range.
`Range`	`inverse()` Returns reversed range.
`boolean`	`isEmpty()` Returns true if `length() == 0`.
`boolean`	`isReverse()` Returns true if this range is reversed.
`int`	`length()` Returns the length of this range.
`Range`	`move(int offset)` Returns range moved using provided offset (e.g.
`Range`	`reverse()` Return reversed range.
`int`	`sig()` Return +1 if this range is normal and -1 if it is reversed
`String`	`toString()`
`Range`	`tryMerge(Range other)` Returns union range with `other` range.
`List<Range>`	`without(Range range)` Subtract provided range and return list of ranges contained in current range and not intersecting with other range.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COMPARATOR_BY_FROM
```
public static final Comparator<Range> COMPARATOR_BY_FROM
```
- Constructor Detail
  - Range
```
public Range(int lower,
     int upper,
     boolean reversed)
```
  - Range
```
public Range(int from,
     int to)
```
- Method Detail
  - expand
```
public Range expand(int offset)
```
  - expand
```
public Range expand(int leftOffset,
           int rightOffset)
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if length() == 0.
    
    Returns:
    true if length() == 0.
  - length
```
public int length()
```
    Returns the length of this range.
    
    Returns:
    length of this range
  - isReverse
```
public boolean isReverse()
```
    Returns true if this range is reversed.
    
    Returns:
    true if this range is reversed
  - sig
```
public int sig()
```
    Return +1 if this range is normal and -1 if it is reversed
    
    Returns:
    +1 if this range is normal and -1 if it is reversed
  - reverse
```
public Range reverse()
```
    Return reversed range.
    
    Returns:
    reversed range
  - hasSameDirection
```
public boolean hasSameDirection(Range other)
```
    Returns true if two ranges has the same direction. Always return true if any of ranges are empty.
    
    Parameters:
    other - other range to compare with
    
    Returns:
    true if two ranges has the same direction. Always return true if any of ranges are of zero length
  - getFrom
```
public int getFrom()
```
    Returns from value. This bound may be exclusive of inclusive depending on the range orientation (see main contract in the class description).
    
    Returns:
    from value (exclusive or inclusive)
  - getTo
```
public int getTo()
```
    Returns to value. This bound may be exclusive of inclusive depending on the range orientation (see main contract in the class description).
    
    Returns:
    to value (exclusive or inclusive)
  - getUpper
```
public int getUpper()
```
    Returns upper (with biggest value) bound of this range. This bound is always exclusive.
    
    Returns:
    upper limit of this range (exclusive)
  - getLower
```
public int getLower()
```
    Returns lower (with least value) bound of this range. This bound is always inclusive.
    
    Returns:
    lower limit of this range (inclusive)
  - inverse
```
public Range inverse()
```
    Returns reversed range.
    
    Returns:
    reversed range
  - contains
```
public boolean contains(int position)
```
    Returns true if range contains provided position.
    
    Parameters:
    position - position
    
    Returns:
    true if range contains provided position
  - containsBoundary
```
public boolean containsBoundary(int position)
```
  - contains
```
public boolean contains(Range other)
```
    Returns true if range contains other range.
    
    Parameters:
    other - other range
    
    Returns:
    true if range contains other range
  - intersectsWith
```
public boolean intersectsWith(Range other)
```
    Returns true if range intersects with other range.
    
    Parameters:
    other - other range
    
    Returns:
    true if range intersects with other range
  - intersectsWithOrTouches
```
public boolean intersectsWithOrTouches(Range other)
```
    Returns true if range intersects with or touches other range.
    
    Parameters:
    other - other range
    
    Returns:
    true if range intersects with or touches other range
  - intersection
```
public Range intersection(Range other)
```
    Returns intersection range with other range.
    
    Parameters:
    other - other range
    
    Returns:
    intersection range with other range or null if ranges not intersects
  - intersectionWithTouch
```
public Range intersectionWithTouch(Range other)
```
    Returns intersection range with other range.
    
    Parameters:
    other - other range
    
    Returns:
    intersection range with other range or null if ranges not intersects
  - tryMerge
```
public Range tryMerge(Range other)
```
    Returns union range with other range.
    
    Parameters:
    other - other range
    
    Returns:
    union range with other range or null if ranges not intersects ot touches
  - move
```
public Range move(int offset)
```
    Returns range moved using provided offset (e.g. [lower + offset, upper + offset, reversed])
    
    Parameters:
    offset - offset, can be negative
    
    Returns:
    range moved using provided offset
  - convertPointToRelativePosition
```
public int convertPointToRelativePosition(int absolutePosition)
```
    Returns relative point position inside this range.
    
    Parameters:
    absolutePosition - absolute point position (in the same coordinates as this range boundaries)
    
    Returns:
    relative point position inside this range
  - convertBoundaryToRelativePosition
```
public int convertBoundaryToRelativePosition(int absolutePosition)
```
    Returns relative boundary position inside this range.
    
    Parameters:
    absolutePosition - absolute boundary position (in the same coordinates as this range boundaries)
    
    Returns:
    relative boundary position inside this range
  - without
```
public List<Range> without(Range range)
```
    Subtract provided range and return list of ranges contained in current range and not intersecting with other range.
    
    Parameters:
    range - range to subtract
    
    Returns:
    list of ranges contained in current range and not intersecting with other range
  - getRelativeRangeOf
```
public Range getRelativeRangeOf(Range absoluteRange)
```
  - convertBoundariesToRelativePosition
```
public int[] convertBoundariesToRelativePosition(int... absolutePositions)
```
  - convertPointsToRelativePosition
```
public int[] convertPointsToRelativePosition(int... absolutePositions)
```
  - convertPointToAbsolutePosition
```
public int convertPointToAbsolutePosition(int relativePosition)
```
    Converts relative point position to absolute position
    
    Parameters:
    relativePosition - relative point position
    
    Returns:
    absolute point position
  - convertBoundaryToAbsolutePosition
```
public int convertBoundaryToAbsolutePosition(int relativePosition)
```
    Converts relative boundary position to absolute position
    
    Parameters:
    relativePosition - relative boundary position
    
    Returns:
    absolute point position
  - getAbsoluteRangeFor
```
public Range getAbsoluteRangeFor(Range relativeRange)
```
    Reverse operation for getRelativeRangeOf(Range). A.getAbsoluteRangeFor(A.getRelativeRangeOf(B)) == B
    
    Parameters:
    relativeRange - range defined relative to this range
    
    Returns:
    absolute range
  - compareTo
```
public int compareTo(Range o)
```
    Specified by:
    
    compareTo in interface Comparable<Range>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Range

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPARATOR_BY_FROM

Constructor Detail

Range

Range

Method Detail

expand

expand

isEmpty

length

isReverse

sig

reverse

hasSameDirection

getFrom

getTo

getUpper

getLower

inverse

contains

containsBoundary

contains

intersectsWith

intersectsWithOrTouches

intersection

intersectionWithTouch

tryMerge

move

convertPointToRelativePosition

convertBoundaryToRelativePosition

without

getRelativeRangeOf

convertBoundariesToRelativePosition

convertPointsToRelativePosition

convertPointToAbsolutePosition

convertBoundaryToAbsolutePosition

getAbsoluteRangeFor

compareTo

toString

equals

hashCode