Range (MeteoInfoLib 1.9 API)

java.lang.Object
- org.meteoinfo.ndarray.Range

```
@Immutable
public final class Range
extends Object
```
Represents a set of integers, used as an index for arrays. It should be considered as a subset of the interval of integers [0, length-1] inclusive. For example Range(1:11:3) represents the set of integers {1,4,7,10} Immutable.
Ranges are monotonically increasing. Elements must be nonnegative. EMPTY is the empty Range. VLEN is for variable length dimensions.
Note last is inclusive, so standard iteration is
```
 for (int i=range.first(); i<=range.last(); i+= range.stride()) {
   ...
 }
 or use:
 Range.Iterator iter = timeRange.getIterator();
 while (iter.hasNext()) {
   int index = iter.next();
   ...
 }
 
```
作者:

caron

嵌套类概要

嵌套类
限定符和类型类说明

class Range.Iterator

嵌套类
限定符和类型	类	说明
`class`	`Range.Iterator`

字段概要

字段
限定符和类型字段说明

static Range EMPTY

static Range ONE

static Range VLEN

字段
限定符和类型	字段	说明
`static Range`	`EMPTY`
`static Range`	`ONE`
`static Range`	`VLEN`

构造器概要

构造器
构造器	说明
`Range(int length)`	Create a range starting at zero, with unit stride.
`Range(int first, int last)`	Create a range with unit stride.
`Range(int first, int last, int stride)`	Create a range with a specified stride.
`Range(String name, int first, int last)`	Create a named range with unit stride.
`Range(String name, int first, int last, int stride)`	Create a named range with a specified stride.
`Range(String name, Range r)`	Copy Constructor with name
`Range(Range r)`	Copy Constructor

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`static List`	`appendShape(List ranges, int size)`	已过时。 use Section.appendRange(int size)
`static String`	`checkInRange(List section, int[] shape)`	已过时。 use Section.checkInRange(int shape[])
`Range`	`compact()`	Create a new Range by compacting this Range by removing the stride.
`Range`	`compose(Range r)`	Create a new Range by composing a Range that is reletive to this Range.
`static long`	`computeSize(List section)`	已过时。 use Section.computeSize()
`boolean`	`contains(int i)`	Is the ith element contained in this Range?
`int`	`element(int i)`	Get ith element
`boolean`	`equals(Object o)`	Range elements with same first, last, stride are equal.
`static List`	`factory(int[] shape)`	已过时。 use Section(int[] shape)
`static List`	`factory(int[] origin, int[] shape)`	已过时。 use Section(int[] origin, int[] shape)
`int`	`first()`
`int`	`getFirstInInterval(int start)`	Find the first element in a strided array after some index start.
`Range.Iterator`	`getIterator()`	Iterate over Range index Usage:
`String`	`getName()`	Get name
`static int[]`	`getOrigin(List ranges)`	已过时。 use Section.getOrigin()
`static int[]`	`getShape(List ranges)`	已过时。 use Section.getShape()
`int`	`hashCode()`	Override Object.hashCode() to implement equals.
`int`	`index(int elem)`	Get the index for this element: inverse of element
`Range`	`intersect(Range r)`	Create a new Range by intersecting with a Range using same interval as this Range.
`boolean`	`intersects(Range r)`	Determine if a given Range intersects this one.
`int`	`last()`
`int`	`length()`	Get the number of elements in the range.
`static String`	`makeSectionSpec(List ranges)`	已过时。 use Section.toString()
`int`	`max()`	已过时。 use last()
`int`	`min()`	已过时。 use first()
`static List`	`parseSpec(String sectionSpec)`	已过时。 use new Section(String sectionSpec)
`boolean`	`past(Range want)`	If this range is completely past the wanted range
`static List`	`setDefaults(List rangeList, int[] shape)`	已过时。 use Section.setDefaults(int[] shape)
`Range`	`shiftOrigin(int origin)`	Create a new Range shifting this range by a constant factor.
`int`	`stride()`
`static Range[]`	`toArray(List ranges)`	已过时。 use Section.getRanges()
`static List`	`toList(Range[] ranges)`	已过时。 use Section.getRanges()
`String`	`toString()`
`static String`	`toString(List ranges)`	已过时。 use Section.toString()
`Range`	`union(Range r)`	Create a new Range by making the union with a Range using same interval as this Range.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - EMPTY
```
public static final Range EMPTY
```
  - ONE
```
public static final Range ONE
```
  - VLEN
```
public static final Range VLEN
```
- 构造器详细资料
  - Range
```
public Range(int first,
             int last)
      throws InvalidRangeException
```
    Create a range with unit stride.
    
    参数:
    
    first - first value in range
    
    last - last value in range, inclusive
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative, 0 <= first <= last
  - Range
```
public Range(int length)
```
    Create a range starting at zero, with unit stride.
    
    参数:
    
    length - number of elements in the Rnage
  - Range
```
public Range(String name,
             int first,
             int last)
      throws InvalidRangeException
```
    Create a named range with unit stride.
    
    参数:
    
    name - name of Range
    
    first - first value in range
    
    last - last value in range, inclusive
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative, 0 <= first <= last
  - Range
```
public Range(int first,
             int last,
             int stride)
      throws InvalidRangeException
```
    Create a range with a specified stride.
    
    参数:
    
    first - first value in range
    
    last - last value in range, inclusive
    
    stride - stride between consecutive elements, must be > 0
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative: 0 <= first <= last, stride > 0
  - Range
```
public Range(String name,
             int first,
             int last,
             int stride)
      throws InvalidRangeException
```
    Create a named range with a specified stride.
    
    参数:
    
    name - name of Range
    
    first - first value in range
    
    last - last value in range, inclusive
    
    stride - stride between consecutive elements, must be > 0
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative: 0 <= first <= last, stride > 0
  - Range
```
public Range(Range r)
```
    Copy Constructor
    
    参数:
    
    r - copy from here
  - Range
```
public Range(String name,
             Range r)
```
    Copy Constructor with name
    
    参数:
    
    name - result name
    
    r - copy from here
- 方法详细资料
  - compose
```
public Range compose(Range r)
              throws InvalidRangeException
```
    Create a new Range by composing a Range that is reletive to this Range. Revised 2013/04/19 by Dennis Heimbigner to handle edge cases. See the commentary associated with the netcdf-c file dceconstraints.h, function dceslicecompose().
    
    参数:
    
    r - range reletive to base
    
    返回:
    
    combined Range, may be EMPTY
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative, 0 <= first <= last
  - compact
```
public Range compact()
              throws InvalidRangeException
```
    Create a new Range by compacting this Range by removing the stride. first = first/stride, last=last/stride, stride=1.
    
    返回:
    
    compacted Range
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative, 0 <= first <= last
  - shiftOrigin
```
public Range shiftOrigin(int origin)
                  throws InvalidRangeException
```
    Create a new Range shifting this range by a constant factor.
    
    参数:
    
    origin - subtract this from first, last
    
    返回:
    
    shiften range
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative, 0 <= first <= last
  - intersect
```
public Range intersect(Range r)
                throws InvalidRangeException
```
    Create a new Range by intersecting with a Range using same interval as this Range. NOTE: we dont yet support intersection when both Ranges have strides
    
    参数:
    
    r - range to intersect
    
    返回:
    
    intersected Range, may be EMPTY
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative
  - intersects
```
public boolean intersects(Range r)
```
    Determine if a given Range intersects this one. NOTE: we dont yet support intersection when both Ranges have strides
    
    参数:
    
    r - range to intersect
    
    返回:
    
    true if they intersect
    
    抛出:
    
    UnsupportedOperationException - if both Ranges have strides
  - past
```
public boolean past(Range want)
```
    If this range is completely past the wanted range
    
    参数:
    
    want - desired range
    
    返回:
    
    true if first() > want.last()
  - union
```
public Range union(Range r)
            throws InvalidRangeException
```
    Create a new Range by making the union with a Range using same interval as this Range. NOTE: no strides
    
    参数:
    
    r - range to add
    
    返回:
    
    intersected Range, may be EMPTY
    
    抛出:
    
    InvalidRangeException - elements must be nonnegative
  - length
```
public int length()
```
    Get the number of elements in the range.
    
    返回:
    
    the number of elements in the range.
  - element
```
public int element(int i)
            throws InvalidRangeException
```
    Get ith element
    
    参数:
    
    i - index of the element
    
    返回:
    
    the i-th element of a range.
    
    抛出:
    
    InvalidRangeException - i must be: 0 <= i < length
  - index
```
public int index(int elem)
          throws InvalidRangeException
```
    Get the index for this element: inverse of element
    
    参数:
    
    elem - the element of the range
    
    返回:
    
    index
    
    抛出:
    
    InvalidRangeException - if illegal elem
  - contains
```
public boolean contains(int i)
```
    Is the ith element contained in this Range?
    
    参数:
    
    i - index in the original Range
    
    返回:
    
    true if the ith element would be returned by the Range iterator
  - first
```
public int first()
```
    返回:
    
    first in range
  - last
```
public int last()
```
    返回:
    
    last in range, inclusive
  - stride
```
public int stride()
```
    返回:
    
    stride, must be >= 1
  - getName
```
public String getName()
```
    Get name
    
    返回:
    
    name, or null if none
  - getIterator
```
public Range.Iterator getIterator()
```
    Iterate over Range index Usage:
```
 Iterator iter = range.getIterator();
 while (iter.hasNext()) {
   int index = iter.next();
   doSomething(index);
 }
 
```
    返回:
    
    Iterator over element indices
  - getFirstInInterval
```
public int getFirstInInterval(int start)
```
    Find the first element in a strided array after some index start. Return the smallest element k in the Range, such that
    - k >= first
    - k >= start
    - k <= last
    - k = first + i * stride for some integer i.
    参数:
    
    start - starting index
    
    返回:
    
    first in interval, else -1 if there is no such element.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    Range elements with same first, last, stride are equal.
    
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    Override Object.hashCode() to implement equals.
    
    覆盖:
    
    hashCode 在类中 Object
  - min
```
public int min()
```
    已过时。 use first()
    
    返回:
    
    Minimum index, inclusive.
  - max
```
public int max()
```
    已过时。 use last()
    
    返回:
    
    Maximum index, inclusive.
  - factory
```
public static List factory(int[] shape)
```
    已过时。 use Section(int[] shape)
    
    Convert shape array to List of Ranges. Assume 0 origin for all.
  - setDefaults
```
public static List setDefaults(List rangeList,
                               int[] shape)
```
    已过时。 use Section.setDefaults(int[] shape)
    
    Check rangeList has no nulls, set from shape array.
  - factory
```
public static List factory(int[] origin,
                           int[] shape)
                    throws InvalidRangeException
```
    已过时。 use Section(int[] origin, int[] shape)
    
    Convert shape, origin array to List of Ranges.
    
    抛出:
    
    InvalidRangeException
  - getShape
```
public static int[] getShape(List ranges)
```
    已过时。 use Section.getShape()
    
    Convert List of Ranges to shape array using the range.length.
  - toString
```
public static String toString(List ranges)
```
    已过时。 use Section.toString()
  - computeSize
```
public static long computeSize(List section)
```
    已过时。 use Section.computeSize()
    
    /** Compute total number of elements represented by the section.
    
    参数:
    
    section - List of Range objects
    
    返回:
    
    total number of elements
  - appendShape
```
public static List appendShape(List ranges,
                               int size)
                        throws InvalidRangeException
```
    已过时。 use Section.appendRange(int size)
    
    Append a new Range(0,size-1) to the list
    
    参数:
    
    ranges - list of Range
    
    size - add this Range
    
    返回:
    
    same list
    
    抛出:
    
    InvalidRangeException - if size < 1
  - getOrigin
```
public static int[] getOrigin(List ranges)
```
    已过时。 use Section.getOrigin()
    
    Convert List of Ranges to origin array using the range.first.
  - toArray
```
public static Range[] toArray(List ranges)
```
    已过时。 use Section.getRanges()
    
    Convert List of Ranges to array of Ranges. *
  - toList
```
public static List toList(Range[] ranges)
```
    已过时。 use Section.getRanges()
    
    Convert array of Ranges to List of Ranges.
  - makeSectionSpec
```
public static String makeSectionSpec(List ranges)
```
    已过时。 use Section.toString()
    
    Convert List of Ranges to String Spec. Inverse of parseSpec
  - parseSpec
```
public static List parseSpec(String sectionSpec)
                      throws InvalidRangeException
```
    已过时。 use new Section(String sectionSpec)
    Parse an index section String specification, return equivilent list of ucar.ma2.Range objects. The sectionSpec string uses fortran90 array section syntax, namely:
```
   sectionSpec := dims
   dims := dim | dim, dims
   dim := ':' | slice | start ':' end | start ':' end ':' stride
   slice := INTEGER
   start := INTEGER
   stride := INTEGER
   end := INTEGER
 
 where nonterminals are in lower case, terminals are in upper case, literals are in single quotes.
 

 Meaning of index selector :
  ':' = all
  slice = hold index to that value
  start:end = all indices from start to end inclusive
  start:end:stride = all indices from start to end inclusive with given stride
 

 
```
    参数:
    
    sectionSpec - the token to parse, eg "(1:20,:,3,10:20:2)", parenthesis optional
    
    返回:
    
    return List of ucar.ma2.Range objects corresponding to the index selection. A null Range means "all" (i.e.":") indices in that dimension.
    
    抛出:
    
    IllegalArgumentException - when sectionSpec is misformed
    
    InvalidRangeException
  - checkInRange
```
public static String checkInRange(List section,
                                  int[] shape)
```
    已过时。 use Section.checkInRange(int shape[])
    
    Check ranges are valid
    
    参数:
    
    section -
    
    shape -
    
    返回:
    
    error message, or null if all ok

类 Range

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

EMPTY

ONE

VLEN

构造器详细资料

Range

Range

Range

Range

Range

Range

Range

方法详细资料

compose

compact

shiftOrigin

intersect

intersects

past

union

length

element

index

contains

first

last

stride

getName

getIterator

getFirstInInterval

toString

equals

hashCode

min

max

factory

setDefaults

factory

getShape

toString

computeSize

appendShape

getOrigin

toArray

toList

makeSectionSpec

parseSpec

checkInRange