org.neo4j.gds.paths.PathResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algo Show documentation

Neo4j Graph Data Science :: Algorithms

There is a newer version: 2.15.0

/*
 * 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;

import org.immutables.value.Value;
import org.neo4j.gds.annotation.ValueClass;

@ValueClass
public interface PathResult {

    PathResult EMPTY = ImmutablePathResult.builder()
        .index(-1)
        .sourceNode(-1)
        .targetNode(-1)
        .nodeIds(-1)
        .relationshipIds(-1)
        .costs(0)
        .build();

    @Value.Auxiliary
    long index();

    long sourceNode();

    long targetNode();

    @Value.Derived
    default double totalCost() {
        return costs()[costs().length - 1];
    }

    long[] nodeIds();

    long[] relationshipIds();

    double[] costs();
}