org.jgrapht.alg.interfaces.CliqueAlgorithm Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jgrapht-core Show documentation
The newest version!
/*
 * (C) Copyright 2018-2023, by Joris Kinable and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * See the CONTRIBUTORS.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the
 * GNU Lesser General Public License v2.1 or later
 * which is available at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
 */
package org.jgrapht.alg.interfaces;

import org.jgrapht.util.*;

import java.util.*;

/**
 * Algorithm to compute a (weighted) Clique
 * in a graph.
 *
 * @param  vertex the graph vertex type
 *
 * @author Joris Kinable
 */
public interface CliqueAlgorithm
{

    /**
     * Computes a clique.
     *
     * @return a clique
     */
    Clique getClique();

    /**
     * A Clique
     *
     * @param  the vertex type
     */
    interface Clique
        extends Set
    {

        /**
         * Returns the weight of the clique. When solving a weighted clique problem, the weight
         * returned is the sum of the weights of the vertices in the clique. When solving the
         * unweighted variant, the cardinality of the clique is returned instead.
         *
         * @return weight of the independent set
         */
        double getWeight();
    }

    /**
     * Default implementation of a (weighted) clique
     *
     * @param  the vertex type
     */
    class CliqueImpl
        extends WeightedUnmodifiableSet
        implements Clique
    {

        private static final long serialVersionUID = -4336873008459736342L;

        public CliqueImpl(Set clique)
        {
            super(clique);
        }

        public CliqueImpl(Set clique, double weight)
        {
            super(clique, weight);
        }
    }
}