io.deephaven.tuple.CanonicalizableTuple Maven / Gradle / Ivy

Go to download

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

Engine Tuples: Value sequences for use in aggregations, joins, and indexing

There is a newer version: 0.36.1

Show newest version

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

import org.jetbrains.annotations.NotNull;

import java.util.function.UnaryOperator;

/**
 * Interface for immutable tuple classes that can produce a new instance of themselves with canonicalized object
 * elements.
 */
public interface CanonicalizableTuple {

    /**
     * Canonicalize this tuple.
     *
     * @param canonicalizer The canonicalization operator to use on each object element.
     * @return This tuple if already canonical, else a new, canonical tuple of the same type
     */
    TUPLE_TYPE canonicalize(@NotNull UnaryOperator