git.sesse.net Git - casparcg/blob - tbb/include/tbb/blocked_range3d.h

   1 /*
   2     Copyright 2005-2011 Intel Corporation.  All Rights Reserved.
   3
   4     This file is part of Threading Building Blocks.
   5
   6     Threading Building Blocks is free software; you can redistribute it
   7     and/or modify it under the terms of the GNU General Public License
   8     version 2 as published by the Free Software Foundation.
   9
  10     Threading Building Blocks is distributed in the hope that it will be
  11     useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  12     of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with Threading Building Blocks; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19     As a special exception, you may use this file as part of a free software
  20     library without restriction.  Specifically, if other files instantiate
  21     templates or use macros or inline functions from this file, or you compile
  22     this file and link it with other files to produce an executable, this
  23     file does not by itself cause the resulting executable to be covered by
  24     the GNU General Public License.  This exception does not however
  25     invalidate any other reasons why the executable file might be covered by
  26     the GNU General Public License.
  27 */
  28
  29 #ifndef __TBB_blocked_range3d_H
  30 #define __TBB_blocked_range3d_H
  31
  32 #include "tbb_stddef.h"
  33 #include "blocked_range.h"
  34
  35 namespace tbb {
  36
  37 //! A 3-dimensional range that models the Range concept.
  38 /** @ingroup algorithms */
  39 template<typename PageValue, typename RowValue=PageValue, typename ColValue=RowValue>
  40 class blocked_range3d {
  41 public:
  42     //! Type for size of an iteration range
  43     typedef blocked_range<PageValue> page_range_type;
  44     typedef blocked_range<RowValue>  row_range_type;
  45     typedef blocked_range<ColValue>  col_range_type;
  46
  47 private:
  48     page_range_type my_pages;
  49     row_range_type  my_rows;
  50     col_range_type  my_cols;
  51
  52 public:
  53
  54     blocked_range3d( PageValue page_begin, PageValue page_end,
  55                      RowValue  row_begin,  RowValue row_end,
  56                      ColValue  col_begin,  ColValue col_end ) :
  57         my_pages(page_begin,page_end),
  58         my_rows(row_begin,row_end),
  59         my_cols(col_begin,col_end)
  60     {
  61     }
  62
  63     blocked_range3d( PageValue page_begin, PageValue page_end, typename page_range_type::size_type page_grainsize,
  64                      RowValue  row_begin,  RowValue row_end,   typename row_range_type::size_type row_grainsize,
  65                      ColValue  col_begin,  ColValue col_end,   typename col_range_type::size_type col_grainsize ) :
  66         my_pages(page_begin,page_end,page_grainsize),
  67         my_rows(row_begin,row_end,row_grainsize),
  68         my_cols(col_begin,col_end,col_grainsize)
  69     {
  70     }
  71
  72     //! True if range is empty
  73     bool empty() const {
  74         // Yes, it is a logical OR here, not AND.
  75         return my_pages.empty() || my_rows.empty() || my_cols.empty();
  76     }
  77
  78     //! True if range is divisible into two pieces.
  79     bool is_divisible() const {
  80         return  my_pages.is_divisible() || my_rows.is_divisible() || my_cols.is_divisible();
  81     }
  82
  83     blocked_range3d( blocked_range3d& r, split ) :
  84         my_pages(r.my_pages),
  85         my_rows(r.my_rows),
  86         my_cols(r.my_cols)
  87     {
  88         if( my_pages.size()*double(my_rows.grainsize()) < my_rows.size()*double(my_pages.grainsize()) ) {
  89             if ( my_rows.size()*double(my_cols.grainsize()) < my_cols.size()*double(my_rows.grainsize()) ) {
  90                 my_cols.my_begin = col_range_type::do_split(r.my_cols);
  91             } else {
  92                 my_rows.my_begin = row_range_type::do_split(r.my_rows);
  93             }
  94         } else {
  95             if ( my_pages.size()*double(my_cols.grainsize()) < my_cols.size()*double(my_pages.grainsize()) ) {
  96                 my_cols.my_begin = col_range_type::do_split(r.my_cols);
  97             } else {
  98                     my_pages.my_begin = page_range_type::do_split(r.my_pages);
  99             }
 100         }
 101     }
 102
 103     //! The pages of the iteration space
 104     const page_range_type& pages() const {return my_pages;}
 105
 106     //! The rows of the iteration space
 107     const row_range_type& rows() const {return my_rows;}
 108
 109     //! The columns of the iteration space
 110     const col_range_type& cols() const {return my_cols;}
 111
 112 };
 113
 114 } // namespace tbb
 115
 116 #endif /* __TBB_blocked_range3d_H */