org.neo4j.gds.leiden.LeidenResult 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

There is a newer version: 2.15.0

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

import org.jetbrains.annotations.Nullable;
import org.neo4j.gds.collections.ha.HugeLongArray;

import java.util.function.LongUnaryOperator;

@SuppressWarnings("immutables:subtype")
public record LeidenResult(
    HugeLongArray communities,
    int ranLevels,
    boolean didConverge,
    @Nullable LeidenDendrogramManager dendrogramManager,
    double[] modularities,
    double modularity
){

    public long[] intermediateCommunities(long nodeId) {

        if (dendrogramManager != null) {
            var dendrograms = dendrogramManager.getAllDendrograms();
            int levels = ranLevels();
            long[] communities = new long[levels];
            for (int i = 0; i < levels; i++) {
                communities[i] = dendrograms[i].get(nodeId);
            }
            return communities;

        } else {
            return new long[]{communities.get(nodeId)};
        }

    }

    public  LongUnaryOperator communitiesFunction() {
        return communities::get;
    }

}