Shape.h

Go to the documentation of this file.

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.

#ifndef __NCML_MODULE__SHAPE_H__
#define __NCML_MODULE__SHAPE_H__

#include <iostream>
#include <iterator>
#include <Array.h>
#include "NCMLDebug.h"
#include <string>
#include <vector>

using libdap::Array;

namespace ncml_module
{
  class Shape
  {
  public:
    // Indices into the space of the shape.
    typedef std::vector<unsigned int> IndexTuple;

  public: // Inner Classes

       class IndexIterator
       : public std::iterator < std::forward_iterator_tag, IndexTuple >
       {
       public:
         IndexIterator(); // for uninitialized.  Don't use it!
         IndexIterator(const Shape& shape, bool isEnd=false);
         IndexIterator(const IndexIterator& proto);
         ~IndexIterator();
         IndexIterator& operator=(const IndexIterator& rhs);
         bool operator==(const IndexIterator& rhs) const;

         inline bool operator!=(const IndexIterator& rhs) const
         {
           return (! ((*this) == rhs));
          }

         inline IndexIterator& operator++() //prefix
         {
           advanceCurrent();
           return *this;
         }

         inline IndexIterator operator++(int) // postfix...
         {
           // Copy it, this is why prefix increment is preferred in STL...
           Shape::IndexIterator tmp(*this);
           ++(*this);
           return tmp;
         }

         // don't mutate the return, we use it to compute next element!
         inline const Shape::IndexTuple& operator*()
         {
           NCML_ASSERT_MSG(!_end, "Can't reference end iterator!");
           return _current;
         }

       private:
         void advanceCurrent();

         void setCurrentToStart();

       private:
         const Shape* _shape; // the shape of the space we are iterating on.  It cannot change during an iteration!
         IndexTuple _current; // the current point.
         bool _end; // set to true when we reach the end since there's no other way to tell if we're at start or end.
       }; // class IndexIterator

    public:
      friend class IndexIterator;


  public:
    Shape();
    Shape(const Shape& proto);
    Shape(const Array& copyDimsFrom);
    ~Shape();
    Shape& operator=(const Shape& rhs);

    bool operator==(const Shape& rhs) const;

    bool operator!=(const Shape& rhs) const
    {
      return !(*this == rhs);
    }

    bool isConstrained() const;

    void setToUnconstrained();

    inline unsigned int getNumDimensions() const
    {
      return _dims.size();
    }

    static bool areDimensionsEqual(const Array::dimension& lhs, const Array::dimension& rhs);

    inline unsigned int getUnconstrainedSpaceSize() const
    {
      unsigned int size = 1;
      for (unsigned int i=0; i<_dims.size(); ++i)
        {
          size *= _dims[i].size;
        }
      return size;
    }

    inline unsigned int getConstrainedSpaceSize() const
    {
      unsigned int c_size = 1;
      for (unsigned int i=0; i<_dims.size(); ++i)
        {
          c_size *= _dims[i].c_size;
        }
      return c_size;
    }

    unsigned int getRowMajorIndex(const IndexTuple& indices, bool validate=true) const;

    Shape::IndexIterator beginSpaceEnumeration() const;

    Shape::IndexIterator endSpaceEnumeration() const;

    std::string toString() const;

    void print(std::ostream& strm) const;

    static void printDimension(std::ostream& strm, const Array::dimension& dim);

    bool validateIndices(const IndexTuple& indices) const;


  private: // Methods

  private:
    std::vector<Array::dimension> _dims;

  }; // class Shape

} // namespace ncml_module

inline std::ostream &
operator<<(std::ostream &strm, const ncml_module::Shape& shape)
{
    shape.print(strm);
    return strm ;
}
#endif /* __NCML_MODULE__SHAPE_H__ */