com.googlecode.blaisemath.graph.metrics.AverageDegree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaise-graph-theory Show documentation

Graph definitions and algorithms.

There is a newer version: 4.0.8

package com.googlecode.blaisemath.graph.metrics;

/*
 * #%L
 * BlaiseGraphTheory
 * --
 * Copyright (C) 2009 - 2019 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.google.common.graph.Graph;

/**
 * Global metric describing the average degree of the graph.
 *
 * @author Elisha Peterson
 */
public class AverageDegree extends AbstractGraphMetric {

    public AverageDegree() {
        super("Average degree", "Average degree of nodes in the graph. Uses average indegree/outdegree for a directed graph.", true);
    }

    @Override
    public Double apply(Graph graph) {
        return graph.isDirected() ? graph.edges().size() / (double) graph.nodes().size()
                : 2.0 * graph.edges().size() / (double) graph.nodes().size();
    }
}