OpenFOAM logo
Open Source CFD Toolkit

Pair.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     Pair
00027 
00028 Description
00029     An ordered Pair.
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef Pair_H
00034 #define Pair_H
00035 
00036 #include "FixedList.H"
00037 #include "Istream.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                             Class Pair Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 template<class Type>
00049 class Pair
00050 :
00051     public FixedList<Type, 2>
00052 {
00053 
00054 public:
00055 
00056     // Constructors
00057 
00058         //- Null constructor for lists
00059         inline Pair()
00060         {}
00061 
00062         //- Construct from components
00063         inline Pair(const Type& f, const Type& s)
00064         {
00065             first() = f;
00066             second() = s;
00067         }
00068 
00069         //- Construct from Istream
00070         inline Pair(Istream& is)
00071         :
00072             FixedList<Type, 2>(is)
00073         {}
00074 
00075 
00076     // Member Functions
00077 
00078         //- Return first
00079         inline Type first() const
00080         {
00081             return this->operator[](0);
00082         }
00083 
00084         //- Return first
00085         inline Type& first()
00086         {
00087             return this->operator[](0);
00088         }
00089 
00090         //- Return second
00091         inline Type second() const
00092         {
00093             return this->operator[](1);
00094         }
00095 
00096         //- Return second
00097         inline Type& second()
00098         {
00099             return this->operator[](1);
00100         }
00101 
00102         //- Return reverse pair
00103         inline Pair<Type> reversePair() const
00104         {
00105             return Pair<Type>(second(), first());
00106         }
00107 
00108 
00109     // Friend Operators
00110 
00111         inline friend bool operator==(const Pair<Type>& a, const Pair<Type>& b)
00112         {
00113             return
00114             (
00115                 (a.first() == b.first()) && (a.second() == b.second())
00116             );
00117         }
00118 
00119         inline friend bool operator!=(const Pair<Type>& a, const Pair<Type>& b)
00120         {
00121             return (!(a == b));
00122         }
00123 };
00124 
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 } // End namespace Foam
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 #endif
00133 
00134 // ************************************************************************* //
For further information go to www.openfoam.org