Package edu.claflin.finder.logic.cond

# Class DirectedCliqueCondition

java.lang.Object
edu.claflin.finder.logic.Condition
edu.claflin.finder.logic.cond.DirectedCliqueCondition

public class DirectedCliqueCondition extends Condition
Represents a Directed Clique condition. Used to enforce a Clique relationship on a ConditionedGraph. Unlike the standard CliqueCondition, this condition doesn't require there to be an edge from every node to every other node. Instead, the stipulation is that there exist an edge between every two nodes (i.e. there may exist an edge such that Node A points to Node B, but no edge from Node B to Node A exists). The following is a simple example in adjacency list format:
A : { B, C } B : { C }

Version:
  1.0 June 19, 2015
Author:
  Charles Allen Schultz II

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DirectedCliqueCondition()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `satisfies(Graph existingGraph)`
  Used to test if the supplied graph is within the bounds of the condition's implementation.
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### DirectedCliqueCondition

    public DirectedCliqueCondition()

- ## Method Details

  - ### satisfies

    public boolean satisfies(Graph existingGraph)
    Used to test if the supplied graph is within the bounds of the condition's implementation.

    Checks to determine if the supplied graph is a Directed Clique.

    Specified by:
      `satisfies` in class `Condition`
    Parameters:
      `existingGraph` - the Graph object to test against.
    Returns:
      true if the graph is a directed clique.

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`