org.neo4j.gds.closeness.ClosenessCentralityStatsSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proc-centrality Show documentation

Neo4j Graph Data Science :: Procedures :: Centrality

There is a newer version: 2.13.2

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

import org.neo4j.gds.StatsComputationResultConsumer;
import org.neo4j.gds.executor.AlgorithmSpec;
import org.neo4j.gds.executor.ComputationResult;
import org.neo4j.gds.executor.ComputationResultConsumer;
import org.neo4j.gds.executor.ExecutionContext;
import org.neo4j.gds.executor.GdsCallable;
import org.neo4j.gds.executor.NewConfigFunction;
import org.neo4j.gds.result.AbstractCentralityResultBuilder;

import java.util.stream.Stream;

import static org.neo4j.gds.closeness.ClosenessCentrality.CLOSENESS_DESCRIPTION;
import static org.neo4j.gds.executor.ExecutionMode.STATS;

@GdsCallable(name = "gds.closeness.stats", aliases = {"gds.beta.closeness.stats"}, description = CLOSENESS_DESCRIPTION, executionMode = STATS)
public class ClosenessCentralityStatsSpec implements AlgorithmSpec, ClosenessCentralityFactory> {

    @Override
    public String name() {
        return "ClosenessCentralityStream";
    }

    @Override
    public ClosenessCentralityFactory algorithmFactory(ExecutionContext executionContext) {
        return new ClosenessCentralityFactory<>();
    }

    @Override
    public NewConfigFunction newConfigFunction() {
        return (___, config) -> ClosenessCentralityStatsConfig.of(config);
    }

    @Override
    public ComputationResultConsumer> computationResultConsumer() {
        return new StatsComputationResultConsumer<>(this::resultBuilder);

    }


    private AbstractCentralityResultBuilder resultBuilder(
        ComputationResult computationResult,
        ExecutionContext executionContext
    ) {
        AbstractCentralityResultBuilder builder = new StatsResult.Builder(
            executionContext.returnColumns(),
            computationResult.config().concurrency()
        );

        computationResult.result().ifPresent(result -> builder.withCentralityFunction(result.centralities()::get));

        return builder;

    }
}