Satsuma
a delicious .NET graph library
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | Static Public Member Functions | Properties | List of all members
Satsuma.Arc Struct Reference

Represents a graph arc, consisting of a wrapped Id. More...

Inheritance diagram for Satsuma.Arc:

Public Member Functions

 Arc (long id)
 Creates an Arc which has the supplied id. More...
 
bool Equals (Arc other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
override string ToString ()
 

Static Public Member Functions

static bool operator!= (Arc a, Arc b)
 
static bool operator== (Arc a, Arc b)
 

Properties

long Id [get, set]
 The integer which uniquely identifies the arc within its containing graph. More...
 
static Arc Invalid [get]
 A special arc value, denoting an invalid arc. More...
 

Detailed Description

Represents a graph arc, consisting of a wrapped Id.

Arcs can be either directed or undirected. Undirected arcs are called edges. Endpoints and directedness of an arc are not stored in this object, but rather they can be queried using methods of the containing graph (see IArcLookup).

Definition at line 87 of file Graph.cs.

Constructor & Destructor Documentation

Satsuma.Arc.Arc ( long  id)

Creates an Arc which has the supplied id.

Definition at line 94 of file Graph.cs.

Member Function Documentation

bool Satsuma.Arc.Equals ( Arc  other)

Definition at line 107 of file Graph.cs.

override bool Satsuma.Arc.Equals ( object  obj)

Definition at line 112 of file Graph.cs.

override int Satsuma.Arc.GetHashCode ( )

Definition at line 118 of file Graph.cs.

static bool Satsuma.Arc.operator!= ( Arc  a,
Arc  b 
)
static

Definition at line 133 of file Graph.cs.

static bool Satsuma.Arc.operator== ( Arc  a,
Arc  b 
)
static

Definition at line 128 of file Graph.cs.

override string Satsuma.Arc.ToString ( )

Definition at line 123 of file Graph.cs.

Property Documentation

long Satsuma.Arc.Id
getset

The integer which uniquely identifies the arc within its containing graph.

Note
Arcs belonging to different graph objects may have the same Id.

Definition at line 91 of file Graph.cs.

Arc Satsuma.Arc.Invalid
staticget

A special arc value, denoting an invalid arc.

This is the default value for the Arc type.

Definition at line 103 of file Graph.cs.


The documentation for this struct was generated from the following file: