org.neo4j.gds.traversal.RandomWalkAlgorithmFactory 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
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.traversal;

import org.neo4j.gds.GraphAlgorithmFactory;
import org.neo4j.gds.api.Graph;
import org.neo4j.gds.core.concurrency.DefaultPool;
import org.neo4j.gds.degree.DegreeCentralityTask;
import org.neo4j.gds.mem.MemoryEstimation;
import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
import org.neo4j.gds.core.utils.progress.tasks.Task;
import org.neo4j.gds.core.utils.progress.tasks.Tasks;
import org.neo4j.gds.termination.TerminationFlag;

import java.util.ArrayList;

public class RandomWalkAlgorithmFactory extends GraphAlgorithmFactory {
    @Override
    public String taskName() {
        return "RandomWalk";
    }

    @Override
    public RandomWalk build(
        Graph graph,
        RandomWalkBaseConfig configuration,
        ProgressTracker progressTracker
    ) {
        return RandomWalk.create(
            graph,
            configuration.concurrency(),
            configuration.walkParameters(),
            configuration.sourceNodes(),
            configuration.walkBufferSize(),
            configuration.randomSeed(),
            progressTracker,
            DefaultPool.INSTANCE,
            TerminationFlag.RUNNING_TRUE
        );
    }

    @Override
    public Task progressTask(
        Graph graph, CONFIG config
    ) {
        var tasks = new ArrayList();
        if (graph.hasRelationshipProperty()) {
            tasks.add(DegreeCentralityTask.create(graph));
        }
        tasks.add(Tasks.leaf("create walks", graph.nodeCount()));

        return Tasks.task(taskName(), tasks);
    }

    @Override
    public MemoryEstimation memoryEstimation(CONFIG config) {
        return new RandomWalkMemoryEstimateDefinition(config.toMemoryEstimateParameters()).memoryEstimation();
    }
}