org.neo4j.gds.traversal.RandomWalkTaskSupplier Maven / Gradle / Ivy

Go to download
/*
 * 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.api.Graph;
import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
import org.neo4j.gds.ml.core.samplers.RandomWalkSampler;
import org.neo4j.gds.termination.TerminationFlag;

import java.util.concurrent.BlockingQueue;
import java.util.function.Supplier;

class RandomWalkTaskSupplier implements Supplier {
    private final Supplier graphSupplier;
    private final NextNodeSupplier nextNodeSupplier;
    private final RandomWalkSampler.CumulativeWeightSupplier cumulativeWeightSupplier;
    private final BlockingQueue walks;
    private final WalkParameters walkParameters;
    private final long randomSeed;
    private final ProgressTracker progressTracker;
    private final TerminationFlag terminationFlag;

    RandomWalkTaskSupplier(
        Supplier graphSupplier,
        NextNodeSupplier nextNodeSupplier,
        RandomWalkSampler.CumulativeWeightSupplier cumulativeWeightSupplier,
        BlockingQueue walks,
        WalkParameters walkParameters,
        long randomSeed,
        ProgressTracker progressTracker,
        TerminationFlag terminationFlag
    ) {
        this.graphSupplier = graphSupplier;
        this.nextNodeSupplier = nextNodeSupplier;
        this.cumulativeWeightSupplier = cumulativeWeightSupplier;
        this.walks = walks;
        this.walkParameters = walkParameters;
        this.randomSeed = randomSeed;
        this.progressTracker = progressTracker;
        this.terminationFlag = terminationFlag;
    }

    @Override
    public RandomWalkTask get() {
        return new RandomWalkTask(
            graphSupplier.get(),
            nextNodeSupplier,
            cumulativeWeightSupplier,
            walks,
            walkParameters.walksPerNode(),
            walkParameters.walkLength(),
            walkParameters.returnFactor(),
            walkParameters.inOutFactor(),
            randomSeed,
            progressTracker,
            terminationFlag
        );
    }
}