org.neo4j.gds.paths.traverse.BfsBaseConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of path-finding-configs Show documentation

Neo4j Graph Data Science :: Path Finding Configurations

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.traverse;

import org.neo4j.gds.annotation.Configuration;
import org.neo4j.gds.config.AlgoBaseConfig;
import org.neo4j.gds.config.SourceNodeConfig;
import org.neo4j.gds.config.TargetNodesConfig;

@Configuration
public interface BfsBaseConfig extends AlgoBaseConfig, SourceNodeConfig, TargetNodesConfig {

    long NO_MAX_DEPTH = -1L;

    default long maxDepth() {
        return NO_MAX_DEPTH;
    }

    @Configuration.Ignore
    default boolean hasMaxDepth() {
        return maxDepth() != NO_MAX_DEPTH;
    }
}