org.neo4j.gds.scaling.ScalePropertiesProc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proc-misc Show documentation

Neo4j Graph Data Science :: Procedures :: Misc

There is a newer version: 2.10.1

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

import org.neo4j.gds.algorithms.misc.ScaledPropertiesNodePropertyValues;
import org.neo4j.gds.api.properties.nodes.NodePropertyValues;
import org.neo4j.gds.collections.ha.HugeObjectArray;
import org.neo4j.gds.executor.ComputationResult;
import org.neo4j.gds.scaleproperties.ScaleProperties;
import org.neo4j.gds.scaleproperties.ScalePropertiesBaseConfig;
import org.neo4j.gds.scaleproperties.ScalePropertiesResult;

public final class ScalePropertiesProc {
    
    private ScalePropertiesProc() {}

    static final String SCALE_PROPERTIES_DESCRIPTION = "Scale node properties";

    static NodePropertyValues nodeProperties(
        ComputationResult computationResult
    ) {
        var size = computationResult.graph().nodeCount();
        var scaledProperties = computationResult.result()
            .map(ScalePropertiesResult::scaledProperties)
            .orElseGet(() -> HugeObjectArray.newArray(double[].class, 0));

        return new ScaledPropertiesNodePropertyValues(size, scaledProperties);
    }

    static NodePropertyValues nodeProperties(long size, HugeObjectArray scaledProperties) {
        return new ScaledPropertiesNodePropertyValues(size, scaledProperties);
    }

    static void validateLegacyScalers(ScalePropertiesBaseConfig config, boolean allowL1L2Scalers) {
        var specifiedScaler = config.scaler().type();
        if (!allowL1L2Scalers && (specifiedScaler.equals(L1Norm.TYPE) || specifiedScaler.equals(L2Norm.TYPE))) {
            ScalerFactory.throwForInvalidScaler(specifiedScaler);
        }
    }

}