Package ucar.nc2.write

Class ChunkingIndex

java.lang.Object

ucar.ma2.Index

ucar.nc2.write.ChunkingIndex

All Implemented Interfaces:

Cloneable

public class ChunkingIndex
extends Index

An index that computes chunk shapes. It is intended to be used to compute the origins and shapes for a series of contiguous writes to a multidimensional array. It writes the first n elements (n < maxChunkElems), then the next, etc. Contributed by cwardgar@usgs.gov 4/12/2010

Field Summary

Fields inherited from class ucar.ma2.Index

scalarIndexImmutable

Constructor Summary

Constructors

Constructor	Description
ChunkingIndex(int[] shape)

Method Summary

Modifier and Type	Method	Description
int[]	computeChunkShape(long maxChunkElems)	Computes the shape of the largest possible contiguous chunk, starting at Index.getCurrentCounter() and with numElems <= maxChunkElems.

Methods inherited from class ucar.ma2.Index

clone, computeSize, currentElement, factory, getCurrentCounter, getRank, getShape, getShape, getSize, incr, set, set, set, set, set, set, set, set, set0, set1, set2, set3, set4, set5, set6, setCurrentCounter, setDim, toString, toStringDebug

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ChunkingIndex

public ChunkingIndex(int[] shape)

Method Details

computeChunkShape

public int[] computeChunkShape(long maxChunkElems)

Computes the shape of the largest possible contiguous chunk, starting at Index.getCurrentCounter() and with numElems <= maxChunkElems.

Parameters:

maxChunkElems - the maximum number of elements in the chunk shape. The actual element count of the shape returned is likely to be different, and can be found with Index.computeSize(int[]).

Returns:

the shape of the largest possible contiguous chunk.