io.deephaven.chunk.ChunkChunkBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-chunk Show documentation

Engine Chunks: Array-like data structures for dense, efficient data movement

The newest version!

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.chunk;

import io.deephaven.chunk.attributes.Any;

/**
 * A generic object intended to serve as a thin wrapper around a multidimensional array region.
 */
public abstract class ChunkChunkBase implements ChunkChunk {
    /**
     * The Chunk-of-Chunk's storage is the sub-range of the underlying array defined by [offset, offset + capacity). It
     * is illegal to access the underlying array outside of this range.
     */
    int offset;
    int capacity;
    /**
     * Useful data in the chunk-of-chunks is in the sub-range of the underlying array defined by [offset, offset +
     * size). It is illegal to set size < 0 or size > capacity.
     */
    int size;

    ChunkChunkBase(int arrayLength, int offset, int capacity) {
        ChunkHelpers.checkArrayArgs(arrayLength, offset, capacity);
        this.offset = offset;
        this.capacity = capacity;
        this.size = capacity;
    }

    @Override
    public final int size() {
        return size;
    }
}