Files
OCCT/src/GraphTools/GraphTools_TopologicalSortFromIterator.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

121 lines
4.2 KiB
Plaintext
Executable File

-- Created on: 1992-12-24
-- Created by: Denis PASCAL
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
generic class TopologicalSortFromIterator from GraphTools
(Graph as any;
Vertex as any;
VHasher as any;
VIterator as any)
--generic class TopologicalSortFromIterator from GraphTools
-- (Graph as any;
-- Vertex as any;
-- VHasher as MapHasher from TCollection (Vertex);
-- VIterator as VertexIterator (Graph,Vertex))
---Purpose: This generic class defines an iterator to visit
-- each vertex of the underlying graph, in such an
-- order that noone vertex is reach before any vertex
-- that point to it. In general the order produced by
-- topological sort is not unique. Usefull for DAG
-- Topological Sort. The option <ignoreSelfLoop>
-- allows the user to ignore (or not) any vertex wich
-- contains a self loop. The option <processCycle>
-- allows the user to visit (or not> vertices which
-- are in a cycle.
uses SequenceOfInteger from TColStd
raises NoSuchObject from Standard,
NoMoreObject from Standard,
DomainError from Standard
private class TSMap instantiates IndexedDataMap from TCollection
(Vertex,TSNode from GraphTools,VHasher);
is
Create
---Purpose: Create an empty algorithm.
returns TopologicalSortFromIterator from GraphTools;
FromVertex (me : in out; V : Vertex);
---Purpose: Add <V> as initial condition. This method is
-- cumulative. Use Perform method before visting the
-- result of the algorithm.
---Level: Public
Reset (me : in out);
---Purpose: Reset the algorithm. It may be reused with new
-- initial conditions.
---Level: Public
Perform (me : in out; G : Graph;
ignoreSelfLoop : Boolean from Standard;
processCycle : Boolean from Standard);
---Purpose: Peform the algorithm in <G> from initial setted
-- conditions according to the two following flags.
-- * <ignoreSelfLoop> allows the user to ignore (or
-- not) any vertex wich contains a self loop.
-- * <processCycle> allows the user to visit (or not>
-- vertex which is in a cycle.
---Level: Public
More (me)
returns Boolean from Standard;
---Level: Public
Next (me : in out)
raises NoMoreObject from Standard;
---Level: Public
Value (me)
returns any Vertex
---Level: Public
---C++: return const &
raises NoSuchObject from Standard;
IsInCycle (me)
returns Boolean from Standard
---Purpose: Returns TRUE if the current vertex is in a cycle.
---Level: Public
raises NoSuchObject from Standard;
fields
-- conditions
myVertices : TSMap from GraphTools;
myIgnoreSelfLoop : Boolean from Standard;
myProcessCycle : Boolean from Standard;
-- result
mySort : SequenceOfInteger from TColStd;
myCycles : Integer from Standard;
myCurrent : Integer from Standard;
end TopologicalSortFromIterator;