Index (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.array.Index

```
public class Index
extends Object
```
Indexes for Arrays. An Index refers to a particular element of an array. This is a generalization of index as int[]. Mutable.

Constructor Summary

Constructors
Constructor and Description

Index(Index from)

Constructors
Constructor and Description
`Index(Index from)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`getCurrentIndex()` Get the current index as int[] .
`Index`	`incr(int dim)` Increment the ith dimension.
`static Index`	`of(int[] index)`
`static Index`	`ofRank(int rank)`
`Index`	`set(int... index)` Set the current element's index.
`Index`	`set0(int v)` set current element at dimension 0 to v
`Index`	`set1(int v)` set current element at dimension 1 to v
`Index`	`set2(int v)` set current element at dimension 2 to v
`Index`	`set3(int v)` set current element at dimension 3 to v
`Index`	`set4(int v)` set current element at dimension 4 to v
`Index`	`set5(int v)` set current element at dimension 5 to v
`Index`	`set6(int v)` set current element at dimension 6 to v
`Index`	`setDim(int dim, int value)` Set current element at dimension dim
`Index`	`setElem(long elem)` Set the current multidim index using 1-d element index.

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

- Constructor Detail
  - Index
```
public Index(Index from)
```
- Method Detail
  - ofRank
```
public static Index ofRank(int rank)
```
  - of
```
public static Index of(int[] index)
```
  - incr
```
public Index incr(int dim)
```
    Increment the ith dimension.
    
    Parameters:
    
    dim - which dimension
    
    Returns:
    
    the incremented Index.
  - getCurrentIndex
```
public int[] getCurrentIndex()
```
    Get the current index as int[] .
  - setElem
```
public Index setElem(long elem)
```
    Set the current multidim index using 1-d element index.
  - setDim
```
public Index setDim(int dim,
                    int value)
```
    Set current element at dimension dim
    
    Parameters:
    
    dim - set this dimension
    
    value - to this value
  - set0
```
public Index set0(int v)
```
    set current element at dimension 0 to v
  - set1
```
public Index set1(int v)
```
    set current element at dimension 1 to v
  - set2
```
public Index set2(int v)
```
    set current element at dimension 2 to v
  - set3
```
public Index set3(int v)
```
    set current element at dimension 3 to v
  - set4
```
public Index set4(int v)
```
    set current element at dimension 4 to v
  - set5
```
public Index set5(int v)
```
    set current element at dimension 5 to v
  - set6
```
public Index set6(int v)
```
    set current element at dimension 6 to v
  - set
```
public Index set(int... index)
```
    Set the current element's index.
    
    Parameters:
    
    index - set current value to these values, number of values must be equal to the rank.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if index.length != rank.

Class Index

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Index

Method Detail

ofRank

of

incr

getCurrentIndex

setElem

setDim

set0

set1

set2

set3

set4

set5

set6

set