1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-16 10:54:53 +03:00
occt/src/GraphTools/GraphTools_TopologicalSortFromIterator.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

115 lines
3.8 KiB
Plaintext

-- Created on: 1992-12-24
-- Created by: Denis PASCAL
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
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;