Forward compatibility: flex
[foam-extend-3.2.git] / src / mesh / cfMesh / utilities / containers / subGraph / subGraph.H
blob1b1d02cca9a9c97c1f16bdc1dd7655d91e207205
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | cfMesh: A library for mesh generation
4    \\    /   O peration     |
5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
7 -------------------------------------------------------------------------------
8 License
9     This file is part of cfMesh.
11     cfMesh is free software; you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation; either version 3 of the License, or (at your
14     option) any later version.
16     cfMesh is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with cfMesh.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     subGraph
27 Description
28     This class provides access to a row of a graph
30 SourceFiles
31     subGraphI.H
33 \*---------------------------------------------------------------------------*/
35 #ifndef subGraph_H
36 #define subGraph_H
38 #include "bool.H"
39 #include "Ostream.H"
40 #include "error.H"
41 #include "graphRow.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 template<class graphType> class subGraph;
49 template<class graphType>
50 Ostream& operator<<(Ostream&, const subGraph<graphType>&);
52 /*---------------------------------------------------------------------------*\
53                            Class subGraph Declaration
54 \*---------------------------------------------------------------------------*/
56 template<class graphType>
57 class subGraph
59     // Private data
60         //- reference to the graph
61         graphType& data_;
63         //- starts at row
64         const label start_;
66         //- number of rows in the subGraph
67         const label size_;
69     // Private member functions
70         //- check index
71         inline void checkIndex(const label i) const;
73 public:
75     // Constructors
77         //- Construct from graph and start row and size
78         inline subGraph(graphType&, const label, const label);
80         //- Copy contructor
81         inline subGraph(const subGraph<graphType>&);
83     // Destructor
85         inline ~subGraph();
87     // Member Functions
89         //- Returns the number of rows
90         inline label size() const;
92         //- Returns the size of a given row
93         inline label sizeOfRow(const label rowI) const;
95     // Member Operators
97         //- Append an element to the given row
98         inline void append(const label rowI, const label);
100         //- Append an element to the given row if it does not exist there
101         inline void appendIfNotIn(const label rowI, const label);
103         //- check if the element is in the given row (takes linear time)
104         inline bool contains(const label rowI, const label e) const;
105         inline label containsAtPosition(const label rowI, const label e) const;
107         //- set and get operators
108         inline label operator()(const label i, const label j) const;
109         inline label& operator()(const label i, const label j);
110         inline const graphRow<const graphType> operator[](const label) const;
111         inline graphRow<graphType> operator[](const label);
113     // IOstream operators
115         // Write subGraph to Ostream.
116         friend Ostream& operator<< <graphType>
117         (
118             Ostream&,
119             const subGraph<graphType>&
120         );
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 } // End namespace Foam
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 #include "subGraphI.H"
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 #endif
135 // ************************************************************************* //