org.neo4j.gds.paths.steiner.SteinerTreeStreamProc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proc-path-finding Show documentation
Neo4j Graph Data Science :: Procedures :: Path Finding
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.gds.paths.steiner;

import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
import org.neo4j.gds.procedures.GraphDataScienceProcedures;
import org.neo4j.gds.procedures.algorithms.pathfinding.SteinerTreeStreamResult;
import org.neo4j.procedure.Context;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Internal;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;

import java.util.Map;
import java.util.stream.Stream;

import static org.neo4j.gds.paths.steiner.Constants.STEINER_DESCRIPTION;
import static org.neo4j.gds.procedures.ProcedureConstants.MEMORY_ESTIMATION_DESCRIPTION;
import static org.neo4j.procedure.Mode.READ;

public class SteinerTreeStreamProc {
    @Context
    public GraphDataScienceProcedures facade;

    @Procedure(value = "gds.steinerTree.stream", mode = READ)
    @Description(STEINER_DESCRIPTION)
    public Stream steinerTree(
        @Name(value = "graphName") String graphName,
        @Name(value = "configuration", defaultValue = "{}") Map configuration
    ) {
        return facade.algorithms().pathFinding().steinerTreeStream(graphName, configuration);
    }

    @Procedure(value = "gds.steinerTree.stream.estimate", mode = READ)
    @Description(MEMORY_ESTIMATION_DESCRIPTION)
    public Stream estimate(
        @Name(value = "graphName") Object graphNameOrConfiguration,
        @Name(value = "configuration", defaultValue = "{}") Map configuration
    ) {
        return facade.algorithms().pathFinding().steinerTreeStreamEstimate(graphNameOrConfiguration, configuration);
    }

    @Deprecated
    @Procedure(value = "gds.beta.steinerTree.stream", mode = READ, deprecatedBy = "gds.steinerTree.stream")
    @Description(STEINER_DESCRIPTION)
    @Internal
    public Stream spanningTreeBeta(
        @Name(value = "graphName") String graphName,
        @Name(value = "configuration", defaultValue = "{}") Map configuration
    ) {
        facade.deprecatedProcedures().called("gds.beta.steinerTree.stream");
        facade
            .log()
            .warn("Procedure `gds.beta.steinerTree.stream` has been deprecated, please use `gds.steinerTree.stream`.");
        return steinerTree(graphName, configuration);
    }
}