org.neo4j.gds.influenceMaximization.CELFWriteSpec 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.influenceMaximization;

import com.carrotsearch.hppc.LongDoubleScatterMap;
import org.neo4j.gds.WriteNodePropertiesComputationResultConsumer;
import org.neo4j.gds.api.properties.nodes.NodePropertyValues;
import org.neo4j.gds.core.write.NodeProperty;
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.AbstractResultBuilder;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Stream;

import static org.neo4j.gds.executor.ExecutionMode.WRITE_NODE_PROPERTY;
import static org.neo4j.gds.influenceMaximization.CELFStreamProc.DESCRIPTION;

@GdsCallable(
    name = "gds.influenceMaximization.celf.write",
    aliases = {"gds.beta.influenceMaximization.celf.write"},
    description = DESCRIPTION,
    executionMode = WRITE_NODE_PROPERTY
)
public class CELFWriteSpec implements AlgorithmSpec, CELFAlgorithmFactory> {
    @Override
    public String name() {
        return "CELFWrite";
    }

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

    @Override
    public NewConfigFunction newConfigFunction() {
        return (__, userInput) -> InfluenceMaximizationWriteConfig.of(userInput);
    }

    @Override
    public ComputationResultConsumer> computationResultConsumer() {
        return new WriteNodePropertiesComputationResultConsumer<>(
            this::resultBuilder,
            computationResult -> List.of(NodeProperty.of(
                computationResult.config().writeProperty(),
                nodePropertyValues(computationResult)
            )),
            name()
        );
    }

    private NodePropertyValues nodePropertyValues(ComputationResult computationResult) {
        var celfSeedSet = computationResult.result();
        var graph = computationResult.graph();

        return new CELFNodeProperties(celfSeedSet.orElseGet(() -> new LongDoubleScatterMap(0)), graph.nodeCount());
    }

    private AbstractResultBuilder resultBuilder(
        ComputationResult computationResult,
        ExecutionContext context
    ) {
        var celfSeedSet = computationResult.result()
            .orElseGet(() -> new LongDoubleScatterMap(0));
        var graph = computationResult.graph();
        return WriteResult.builder()
            .withTotalSpread(Arrays.stream(celfSeedSet.values).sum())
            .withNodeCount(graph.nodeCount())
            .withComputeMillis(computationResult.computeMillis())
            .withConfig(computationResult.config());
    }
}