org.neo4j.gds.pagerank.EigenVectorStatsSpec 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.pagerank;

import org.neo4j.gds.executor.ExecutionContext;
import org.neo4j.gds.executor.GdsCallable;
import org.neo4j.gds.executor.NewConfigFunction;

import static org.neo4j.gds.executor.ExecutionMode.STATS;
import static org.neo4j.gds.pagerank.PageRankProcCompanion.EIGENVECTOR_DESCRIPTION;

@GdsCallable(name = "gds.eigenvector.stats", description = EIGENVECTOR_DESCRIPTION, executionMode = STATS)
public class EigenVectorStatsSpec extends  PageRankStatsSpec {

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

    @Override
    public PageRankAlgorithmFactory algorithmFactory(ExecutionContext executionContext) {
        return new PageRankAlgorithmFactory<>(PageRankAlgorithmFactory.Mode.EIGENVECTOR);
    }
    @Override
    public NewConfigFunction newConfigFunction() {
        return (___, config) -> {
            if (config.containsKey("dampingFactor")) {
                throw new IllegalArgumentException("Unexpected configuration key: dampingFactor");
            }
            return PageRankStatsConfig.of(config);
        };
    }


}