com.ibm.wala.util.graph.INodeWithNumberedEdges Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.ibm.wala.util Show documentation

T. J. Watson Libraries for Analysis

The newest version!

/*
 * Copyright (c) 2002 - 2006 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.util.graph;

import com.ibm.wala.util.intset.IntSet;
import org.jspecify.annotations.Nullable;

/**
 * Basic interface for a node which lives in one graph ... it's id is used to implement the {@link
 * NumberedGraph} interface.
 */
public interface INodeWithNumberedEdges extends INodeWithNumber {
  /**
   * @return set of node numbers which are successors of this node
   */
  @Nullable IntSet getSuccNumbers();

  /**
   * @return set of node numbers which are predecessors of this node
   */
  @Nullable IntSet getPredNumbers();

  /** Modify the graph so that node number n is a successor of this node */
  void addSucc(int n);

  /** Modify the graph so that node number n is a predecessor of this node */
  void addPred(int n);

  /**
   * remove all edges that involve this node. This must fix up the other nodes involved in each edge
   * removed.
   */
  void removeAllIncidentEdges();

  /**
   * remove all incoming edges to this this node. This must fix up the other nodes involved in each
   * edge removed.
   */
  void removeIncomingEdges();

  /**
   * remove all outgoing edges to this this node. This must fix up the other nodes involved in each
   * edge removed.
   */
  void removeOutgoingEdges();
}