MemoPatterns.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.nereids.pattern;

import org.apache.doris.nereids.trees.plans.BinaryPlan;
import org.apache.doris.nereids.trees.plans.GroupPlan;
import org.apache.doris.nereids.trees.plans.LeafPlan;
import org.apache.doris.nereids.trees.plans.Plan;
import org.apache.doris.nereids.trees.plans.UnaryPlan;
import org.apache.doris.nereids.trees.plans.algebra.Aggregate;
import org.apache.doris.nereids.trees.plans.logical.LogicalBinary;
import org.apache.doris.nereids.trees.plans.logical.LogicalExcept;
import org.apache.doris.nereids.trees.plans.logical.LogicalIntersect;
import org.apache.doris.nereids.trees.plans.logical.LogicalLeaf;
import org.apache.doris.nereids.trees.plans.logical.LogicalPlan;
import org.apache.doris.nereids.trees.plans.logical.LogicalRelation;
import org.apache.doris.nereids.trees.plans.logical.LogicalSetOperation;
import org.apache.doris.nereids.trees.plans.logical.LogicalUnary;
import org.apache.doris.nereids.trees.plans.logical.LogicalUnion;
import org.apache.doris.nereids.trees.plans.physical.PhysicalBinary;
import org.apache.doris.nereids.trees.plans.physical.PhysicalLeaf;
import org.apache.doris.nereids.trees.plans.physical.PhysicalRelation;
import org.apache.doris.nereids.trees.plans.physical.PhysicalUnary;

import java.util.Arrays;

/** MemoPatterns */
public interface MemoPatterns extends Patterns {

    default PatternDescriptor<GroupPlan> group() {
        return new PatternDescriptor<>(Pattern.GROUP, defaultPromise());
    }

    default PatternDescriptor<GroupPlan> multiGroup() {
        return new PatternDescriptor<>(Pattern.MULTI_GROUP, defaultPromise());
    }

    /* abstract plan operator patterns */

    /**
     * create a leafPlan pattern.
     */
    default PatternDescriptor<LeafPlan> leafPlan() {
        return new PatternDescriptor(new TypePattern(LeafPlan.class), defaultPromise());
    }

    /**
     * create a unaryPlan pattern.
     */
    default PatternDescriptor<UnaryPlan<GroupPlan>> unaryPlan() {
        return new PatternDescriptor(new TypePattern(UnaryPlan.class, Pattern.GROUP), defaultPromise());
    }

    /**
     * create a unaryPlan pattern.
     */
    default <C extends Plan> PatternDescriptor<UnaryPlan<C>>
            unaryPlan(PatternDescriptor<C> child) {
        return new PatternDescriptor(new TypePattern(UnaryPlan.class, child.pattern), defaultPromise());
    }

    /**
     * create a binaryPlan pattern.
     */
    default PatternDescriptor<BinaryPlan<GroupPlan, GroupPlan>> binaryPlan() {
        return new PatternDescriptor(
                new TypePattern(BinaryPlan.class, Pattern.GROUP, Pattern.GROUP),
                defaultPromise()
        );
    }

    /**
     * create a binaryPlan pattern.
     */
    default <LEFT_CHILD_TYPE extends Plan, RIGHT_CHILD_TYPE extends Plan>
            PatternDescriptor<BinaryPlan<LEFT_CHILD_TYPE, RIGHT_CHILD_TYPE>> binaryPlan(
                PatternDescriptor<LEFT_CHILD_TYPE> leftChild,
                PatternDescriptor<RIGHT_CHILD_TYPE> rightChild) {
        return new PatternDescriptor(
                new TypePattern(BinaryPlan.class, leftChild.pattern, rightChild.pattern),
                defaultPromise()
        );
    }

    /* abstract logical plan patterns */

    /**
     * create a logicalPlan pattern.
     */
    default PatternDescriptor<LogicalPlan> logicalPlan() {
        return new PatternDescriptor(new TypePattern(LogicalPlan.class, multiGroup().pattern), defaultPromise());
    }

    /**
     * create a logicalLeaf pattern.
     */
    default PatternDescriptor<LogicalLeaf> logicalLeaf() {
        return new PatternDescriptor(new TypePattern(LogicalLeaf.class), defaultPromise());
    }

    /**
     * create a logicalUnary pattern.
     */
    default PatternDescriptor<LogicalUnary<GroupPlan>> logicalUnary() {
        return new PatternDescriptor(new TypePattern(LogicalUnary.class, Pattern.GROUP), defaultPromise());
    }

    /**
     * create a logicalUnary pattern.
     */
    default <C extends Plan> PatternDescriptor<LogicalUnary<C>>
            logicalUnary(PatternDescriptor<C> child) {
        return new PatternDescriptor(new TypePattern(LogicalUnary.class, child.pattern), defaultPromise());
    }

    /**
     * create a logicalBinary pattern.
     */
    default PatternDescriptor<LogicalBinary<GroupPlan, GroupPlan>> logicalBinary() {
        return new PatternDescriptor(
                new TypePattern(LogicalBinary.class, Pattern.GROUP, Pattern.GROUP),
                defaultPromise()
        );
    }

    /**
     * create a logicalBinary pattern.
     */
    default <LEFT_CHILD_TYPE extends Plan, RIGHT_CHILD_TYPE extends Plan>
            PatternDescriptor<LogicalBinary<LEFT_CHILD_TYPE, RIGHT_CHILD_TYPE>>
            logicalBinary(
                PatternDescriptor<LEFT_CHILD_TYPE> leftChild,
                PatternDescriptor<RIGHT_CHILD_TYPE> rightChild) {
        return new PatternDescriptor(
                new TypePattern(LogicalBinary.class, leftChild.pattern, rightChild.pattern),
                defaultPromise()
        );
    }

    /**
     * create a logicalRelation pattern.
     */
    default PatternDescriptor<LogicalRelation> logicalRelation() {
        return new PatternDescriptor(new TypePattern(LogicalRelation.class), defaultPromise());
    }

    /**
     * create a logicalSetOperation pattern.
     */
    default PatternDescriptor<LogicalSetOperation>
            logicalSetOperation(
                PatternDescriptor... children) {
        return new PatternDescriptor(
                new TypePattern(LogicalSetOperation.class,
                        Arrays.stream(children)
                                .map(PatternDescriptor::getPattern)
                                .toArray(Pattern[]::new)),
                defaultPromise());
    }

    /**
     * create a logicalSetOperation group.
     */
    default PatternDescriptor<LogicalSetOperation> logicalSetOperation() {
        return new PatternDescriptor(
                new TypePattern(LogicalSetOperation.class, multiGroup().pattern),
                defaultPromise());
    }

    /**
     * create a logicalUnion pattern.
     */
    default PatternDescriptor<LogicalUnion>
            logicalUnion(
                PatternDescriptor... children) {
        return new PatternDescriptor(
                new TypePattern(LogicalUnion.class,
                        Arrays.stream(children)
                                .map(PatternDescriptor::getPattern)
                                .toArray(Pattern[]::new)),
                defaultPromise());
    }

    /**
     * create a logicalUnion group.
     */
    default PatternDescriptor<LogicalUnion> logicalUnion() {
        return new PatternDescriptor(
                new TypePattern(LogicalUnion.class, multiGroup().pattern),
                defaultPromise());
    }

    /**
     * create a logicalExcept pattern.
     */
    default PatternDescriptor<LogicalExcept>
            logicalExcept(
                PatternDescriptor... children) {
        return new PatternDescriptor(
                new TypePattern(LogicalExcept.class,
                        Arrays.stream(children)
                                .map(PatternDescriptor::getPattern)
                                .toArray(Pattern[]::new)),
                defaultPromise());
    }

    /**
     * create a logicalExcept group.
     */
    default PatternDescriptor<LogicalExcept> logicalExcept() {
        return new PatternDescriptor(
                new TypePattern(LogicalExcept.class, multiGroup().pattern),
                defaultPromise());
    }

    /**
     * create a logicalUnion pattern.
     */
    default PatternDescriptor<LogicalIntersect>
            logicalIntersect(
                PatternDescriptor... children) {
        return new PatternDescriptor(
                new TypePattern(LogicalIntersect.class,
                        Arrays.stream(children)
                                .map(PatternDescriptor::getPattern)
                                .toArray(Pattern[]::new)),
                defaultPromise());
    }

    /**
     * create a logicalUnion group.
     */
    default PatternDescriptor<LogicalIntersect> logicalIntersect() {
        return new PatternDescriptor(
                new TypePattern(LogicalIntersect.class, multiGroup().pattern),
                defaultPromise());
    }

    /* abstract physical plan patterns */

    /**
     * create a physicalLeaf pattern.
     */
    default PatternDescriptor<PhysicalLeaf> physicalLeaf() {
        return new PatternDescriptor(new TypePattern(PhysicalLeaf.class), defaultPromise());
    }

    /**
     * create a physicalUnary pattern.
     */
    default PatternDescriptor<PhysicalUnary<GroupPlan>> physicalUnary() {
        return new PatternDescriptor(new TypePattern(PhysicalUnary.class, Pattern.GROUP), defaultPromise());
    }

    /**
     * create a physicalUnary pattern.
     */
    default <C extends Plan> PatternDescriptor<PhysicalUnary<C>>
            physicalUnary(PatternDescriptor<C> child) {
        return new PatternDescriptor(new TypePattern(PhysicalUnary.class, child.pattern), defaultPromise());
    }

    /**
     * create a physicalBinary pattern.
     */
    default PatternDescriptor<PhysicalBinary<GroupPlan, GroupPlan>> physicalBinary() {
        return new PatternDescriptor(
                new TypePattern(PhysicalBinary.class, Pattern.GROUP, Pattern.GROUP),
                defaultPromise()
        );
    }

    /**
     * create a physicalBinary pattern.
     */
    default <LEFT_CHILD_TYPE extends Plan, RIGHT_CHILD_TYPE extends Plan>
            PatternDescriptor<PhysicalBinary<LEFT_CHILD_TYPE, RIGHT_CHILD_TYPE>>
            physicalBinary(
                PatternDescriptor<LEFT_CHILD_TYPE> leftChild,
                PatternDescriptor<RIGHT_CHILD_TYPE> rightChild) {
        return new PatternDescriptor(
                new TypePattern(PhysicalBinary.class, leftChild.pattern, rightChild.pattern),
                defaultPromise()
        );
    }

    /**
     * create a physicalRelation pattern.
     */
    default PatternDescriptor<PhysicalRelation> physicalRelation() {
        return new PatternDescriptor(new TypePattern(PhysicalRelation.class), defaultPromise());
    }

    /**
     * create a aggregate pattern.
     */
    default PatternDescriptor<Aggregate<GroupPlan>> aggregate() {
        return new PatternDescriptor(new TypePattern(Aggregate.class, Pattern.GROUP), defaultPromise());
    }

    /**
     * create a aggregate pattern.
     */
    default <C extends Plan> PatternDescriptor<Aggregate<C>> aggregate(PatternDescriptor<C> child) {
        return new PatternDescriptor(new TypePattern(Aggregate.class, child.pattern), defaultPromise());
    }
}