miterd.hh

Go to the documentation of this file.

/*
* This file is part of rasdaman community.
*
* Rasdaman community 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.
*
* Rasdaman community 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 rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*/
 
#ifndef R_MITERD_HH
#define R_MITERD_HH
 
#include "raslib/mddtypes.hh"
#include "raslib/odmgtypes.hh"
 
#include <iosfwd>
 
class r_Minterval;
class r_miter_direct_data;
 
//@ManMemo: Module {\bf raslib}
class r_MiterDirect
{
public:
    r_MiterDirect(const void *data, const r_Minterval &total, const r_Minterval &iter,
                  r_Bytes tlen, unsigned int step = 1);
    ~r_MiterDirect(void);
 
    inline r_MiterDirect &operator++(void);
    inline r_MiterDirect &iterateUserOrder(const r_Dimension *order, const unsigned int *step);
    inline r_MiterDirect &iterateUserOrder(const unsigned int *order, const int *step);
 
    inline bool isDone(void) const;
    inline void *getData(void);
    inline void *getData(unsigned int *order);
    inline r_Range getDimStep(r_Dimension d) const;
    inline r_Range getDimBaseStep(r_Dimension d) const;
    inline r_Range getExtent(r_Dimension d) const;
    inline void posChanged(void);
    void reset(void);
    void print_pos(std::ostream &str) const;
 
    r_miter_direct_data *id{NULL};
    const void *baseAddress{NULL};
 
private:
    r_ULong length{};
    r_Dimension dim{};
 
public:
    bool done{false};
};
 
/*@Doc:
  r_miter_direct_data encapsulates data for each dimension.
  It's an auxiliary class for r_MiterDirect. The only reason
  not to make it a simple struct was data protection.
 */
 
class r_miter_direct_data
{
    friend class r_MiterDirect;
 
public:
    r_miter_direct_data() = default;
    ~r_miter_direct_data() = default;
 
    const void *data{NULL};
    r_Range pos{};
    r_Range low{};
    r_Range high{};
 
private:
    r_Range step{};
    r_Range baseStep{};
    r_Range extent{};
    r_Range origin{};
};
 
extern std::ostream &operator<<(std::ostream &str, const r_MiterDirect &iter);
 
#include "raslib/miterd.icc"
 
#endif