io.deephaven.engine.table.impl.sources.FillUnordered Maven / Gradle / Ivy

Go to download

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

Engine Table: Implementation and closely-coupled utilities

There is a newer version: 0.37.1

Show newest version

/**
 * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
 */
package io.deephaven.engine.table.impl.sources;

import io.deephaven.chunk.attributes.Any;
import io.deephaven.engine.rowset.chunkattributes.RowKeys;
import io.deephaven.chunk.LongChunk;
import io.deephaven.chunk.WritableChunk;
import io.deephaven.engine.table.ChunkSource;
import org.jetbrains.annotations.NotNull;

public interface FillUnordered {
    /**
     * Populates a contiguous portion of the given destination chunk with data corresponding to the keys from the given
     * {@link LongChunk}.
     * 
     * It behaves as if the following code were executed:
     * 
     * 
     * destination.setSize(keys.size());
     * for (int ii = 0; ii < keys.size(); ++ii) {
     *     destination.set(ii, get(keys.get(ii)));
     * }
     * 
     *
     * @param context A context containing all mutable/state related data used in retrieving the Chunk.
     * @param dest The chunk to be populated according to {@code keys}
     * @param keys A chunk of individual, not assumed to be ordered keys to be fetched
     */
    void fillChunkUnordered(
            @NotNull ChunkSource.FillContext context,
            @NotNull WritableChunk dest,
            @NotNull LongChunk keys);

    /**
     * Populates a contiguous portion of the given destination chunk with prev data corresponding to the keys from the
     * given {@link LongChunk}.
     * 
     * It behaves as if the following code were executed:
     * 
     * 
     * destination.setSize(keys.size());
     * for (int ii = 0; ii < keys.size(); ++ii) {
     *     destination.set(ii, getPrev(keys.get(ii)));
     * }
     * 
     *
     * @param context A context containing all mutable/state related data used in retrieving the Chunk.
     * @param dest The chunk to be populated according to {@code keys}
     * @param keys A chunk of individual, not assumed to be ordered keys to be fetched
     */
    void fillPrevChunkUnordered(
            @NotNull ChunkSource.FillContext context,
            @NotNull WritableChunk dest,
            @NotNull LongChunk keys);

    /**
     * Returns true if this column source can efficiently provide an unordered fill.
     *
     * If this method returns false, then fillChunkUnordered and fillPrevChunkUnordered may throw an
     * UnsupportedOperationException.
     *
     * @return if this column source can provide an unordered fill
     */
    boolean providesFillUnordered();

    static boolean providesFillUnordered(ChunkSource chunkSource) {
        return (chunkSource instanceof FillUnordered) && ((FillUnordered) chunkSource).providesFillUnordered();
    }
}