filtcomplex.h

Go to the documentation of this file.

/////////////////////////////////////////////////////////////////////////////
///
/// \file
///
/// A filtered cell complex.
///
/////////////////////////////////////////////////////////////////////////////

// Copyright (C) 2009-2016 by Pawel Pilarczyk.
//
// This file is part of my research software package. This is free software:
// you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
//
// This software is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this software; see the file "license.txt". If not,
// please, see <http://www.gnu.org/licenses/>.

// Started on March 24, 2009. Last revision: January 11, 2013.


#ifndef _CHAINCON_FILTCOMPLEX_H_
#define _CHAINCON_FILTCOMPLEX_H_


// include some standard C++ header files
#include <istream>
#include <ostream>

// include selected header files from the CHomP library
#include "chomp/system/config.h"
#include "chomp/system/textfile.h"
#include "chomp/struct/hashsets.h"


// --------------------------------------------------
// ------------- filtered cell complex --------------
// --------------------------------------------------

/// A filtered complex. Cells must be added to this complex
/// in an order that ensures that any cell that appears in the boundary
/// of another cell is added AFTER that cell.
/// Contains a method for generating the boundaries of all the cells
/// that were previously added to the complex.
/// Then the cells can be accessed in the reversed order using operator [].
template <class CellT>
class tFilteredComplex
{
public:
        /// The type of cells in the filtered complex.
        typedef CellT CellType;

        /// The type of elements in the filtered complex
        /// perceived as a standard-type aggregate.
        typedef CellT value_type;

        /// The default constructor.
        tFilteredComplex ();

        /// Adds a cell to the complex. Does not add its boundary cells.
        /// Returns the number of the added cell in the complex.
        int_t add (const CellT &c);

        /// Finds a cell in the complex.
        /// Returns its number or -1 if not found.
        int_t getNumber (const CellT &c) const;

        /// Checks if a cell is in the complex.
        bool check (const CellT &c) const;

        /// Returns the size of the complex.
        int_t size () const;

        /// Returns the information on whether the complex is empty or not.
        bool empty () const;

        /// Returns the given cell in the complex in the reversed order.
        const CellT &operator [] (int_t n) const;

        /// Swaps the data with another filtered complex.
        void swap (tFilteredComplex<CellT> &fc);

private:
        /// The set of all the cells in the complex in the right order.
        chomp::homology::hashedset<CellT> cells;

}; /* class tFilteredComplex */

// --------------------------------------------------

template <class CellT>
inline tFilteredComplex<CellT>::tFilteredComplex ():
        cells (1024)
{
        return;
} /* tFilteredComplex::tFilteredComplex */

template <class CellT>
inline int_t tFilteredComplex<CellT>::add (const CellT &c)
{
        return cells. add (c);
} /* tFilteredComplex::add */

template <class CellT>
inline int_t tFilteredComplex<CellT>::getNumber (const CellT &c) const
{
        int_t n = cells. getnumber (c);
        return (n >= 0) ? (cells. size () - n - 1) : -1;
} /* tFilteredComplex::getNumber */

template <class CellT>
inline bool tFilteredComplex<CellT>::check (const CellT &c) const
{
        return cells. check (c);
} /* tFilteredComplex::check */

template <class CellT>
inline int_t tFilteredComplex<CellT>::size () const
{
        return cells. size ();
} /* tFilteredComplex::size */

template <class CellT>
inline bool tFilteredComplex<CellT>::empty () const
{
        return cells. empty ();
} /* tFilteredComplex::empty */

template <class CellT>
inline const CellT &tFilteredComplex<CellT>::operator [] (int_t n) const
{
        int_t size = cells. size ();
        if ((n < 0) || (n >= size))
                throw "Wrong number of a cell in a filtered complex.";
        return cells [size - n - 1];
} /* tFilteredComplex::operator [] */

template <class CellT>
inline void tFilteredComplex<CellT>::swap (tFilteredComplex<CellT> &fc)
{
        cells. swap (fc. cells);
} /* tFilteredComplex::swap */


// --------------------------------------------------

/// Writes a filtered cell complex to an output stream in the text format.
template <class CellT>
std::ostream &operator << (std::ostream &out,
        const tFilteredComplex<CellT> &C)
{
        int_t size = C. size ();
        for (int_t i = 0; i < size; ++ i)
        {
                out << C [i] << "\n";
        }
        return out;
} /* operator << */

/// Reads a filtered cell complex from an input stream.
/// The cells are supposed to be listed in the input stream
/// in the reverse order, that is, each cell should be followed
/// by its boundary cells, which is not verified in this procedure.
/// Reading the cells is interrupted in case of the empty cell
/// (which is added to the complex if the empty cell is in use)
/// or when the end of the stream is encountered.
template <class CellT>
std::istream &operator >> (std::istream &in, tFilteredComplex<CellT> &K)
{
        chomp::homology::ignorecomments (in);
        while (!in. eof ())
        {
                CellT s;
                in >> s;
                chomp::homology::ignorecomments (in);
                if (s. dim () < 0)
                {
#ifndef NO_EMPTY_CELL
                        K. add (s);
#endif
                        break;
                }
                K. add (s);
        }
        return in;
} /* operator >> */


#endif // _CHAINCON_FILTCOMPLEX_H_