stattiling.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_STATTILING_HH_
#define _R_STATTILING_HH_
 
// Include statements
 
#include "rasodmg/tiling.hh"
#include "raslib/minterval.hh"
#include "raslib/odmgtypes.hh"
#include <iosfwd>
 
class r_Access;
class r_Stat_Tiling;
 
//@ManMemo: Module: {\bf rasodmg}
 
class r_Access
{
public:
    explicit r_Access(const r_Minterval &pattern, r_ULong accesses = 1);
    const r_Minterval &get_pattern() const;
 
    void set_pattern(const r_Minterval &pattern);
 
    r_ULong get_times() const;
 
    void set_times(r_ULong accesses);
 
    bool is_near(const r_Access &other, r_ULong border_threshold) const;
 
    void merge_with(const r_Access &other);
 
    void print_status(std::ostream &os) const;
 
    bool operator==(const r_Access &other) const;
 
    bool operator!=(const r_Access &other) const;
 
private:
    r_Access() = default;
 
    r_Minterval interval;
 
    r_ULong times{};
};
 
//@ManMemo: Module: {\bf rasodmg}
extern std::ostream &operator<<(std::ostream &os, const r_Access &access);
 
//@ManMemo: Module: {\bf rasodmg}
 
/*@Doc:
  This class implements the "statistic tiling" algorithm.
 
  Three parameters are passed in the constructor of the class,
  the border threshold for considering two access patterns to be the
  same, the interesting threshold which specifies the percentage of
  accesses that must take place so that an areas is considered of interest
  when performing tiling and also the tilesize.
 
  A call to \c update_stat_information should be made prior to performing
  tiling so that the static information about the accesses to the object
  can be updated and the tiling operation prepared.
*/
 
class r_Stat_Tiling : public r_Dimension_Tiling
{
    // ******************* PUBLIC SECTION *******************
 
public:  // constants
    const static r_Area DEF_BORDER_THR;
 
    const static r_Double DEF_INTERESTING_THR;
 
    explicit r_Stat_Tiling(const char *encoded);
 
    r_Stat_Tiling(r_Dimension dim,
                  const std::vector<r_Access> &stat_info,
                  r_Bytes ts = r_Tiling::defaultTileSize,
                  r_Area border_threshold = DEF_BORDER_THR,
                  r_Double interesting_threshold = DEF_INTERESTING_THR);
    virtual ~r_Stat_Tiling() = default;
 
    virtual const std::vector<r_Minterval> &get_interesting_areas() const;
 
    r_Area get_border_threshold() const;
    r_Double get_interesting_threshold() const;
    void print_status(std::ostream &os) const override;
 
    std::vector<r_Minterval> compute_tiles(const r_Minterval &obj_domain, r_Bytes cell_size) const override;
 
    r_Tiling *clone() const override;
 
    r_Tiling_Scheme get_tiling_scheme() const override;
 
    static const char *description;
 
protected:  // methods
    void filter(std::vector<r_Access> &patterns) const;
 
    r_Access merge(const std::vector<r_Access> &patterns) const;
 
    r_Double interesting_thr;
 
    r_Area border_thr;
 
    std::vector<r_Minterval> iareas;
 
    std::vector<r_Access> stat_info;
};
 
#endif