ucar.nc2
Class FileWriter.ChunkingIndex

java.lang.Object
  extended by ucar.ma2.Index
      extended by ucar.nc2.FileWriter.ChunkingIndex
All Implemented Interfaces:
Cloneable
Enclosing class:
FileWriter

public static class FileWriter.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.


Field Summary
 
Fields inherited from class ucar.ma2.Index
current, offset, rank, scalarIndexImmutable, shape, size, stride
 
Constructor Summary
FileWriter.ChunkingIndex(int[] shape)
           
 
Method Summary
 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, precalc, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileWriter.ChunkingIndex

public FileWriter.ChunkingIndex(int[] shape)
Method Detail

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.


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.