Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
blocked_range3d.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2005-2020 Intel Corporation
3 
4  Licensed under the Apache License, Version 2.0 (the "License");
5  you may not use this file except in compliance with the License.
6  You may obtain a copy of the License at
7 
8  http://www.apache.org/licenses/LICENSE-2.0
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 */
16 
17 #ifndef __TBB_blocked_range3d_H
18 #define __TBB_blocked_range3d_H
19 
20 #include "tbb_stddef.h"
21 #include "blocked_range.h"
22 
23 namespace tbb {
24 
26 
27 template<typename PageValue, typename RowValue=PageValue, typename ColValue=RowValue>
29 public:
34 
35 private:
39 
40 public:
41 
42  blocked_range3d( PageValue page_begin, PageValue page_end,
43  RowValue row_begin, RowValue row_end,
44  ColValue col_begin, ColValue col_end ) :
45  my_pages(page_begin,page_end),
46  my_rows(row_begin,row_end),
47  my_cols(col_begin,col_end)
48  {}
49 
50  blocked_range3d( PageValue page_begin, PageValue page_end, typename page_range_type::size_type page_grainsize,
51  RowValue row_begin, RowValue row_end, typename row_range_type::size_type row_grainsize,
52  ColValue col_begin, ColValue col_end, typename col_range_type::size_type col_grainsize ) :
53  my_pages(page_begin,page_end,page_grainsize),
54  my_rows(row_begin,row_end,row_grainsize),
55  my_cols(col_begin,col_end,col_grainsize)
56  {}
57 
59  bool empty() const {
60  // Range is empty if at least one dimension is empty.
61  return my_pages.empty() || my_rows.empty() || my_cols.empty();
62  }
63 
65  bool is_divisible() const {
67  }
68 
70  my_pages(r.my_pages),
71  my_rows(r.my_rows),
72  my_cols(r.my_cols)
73  {
74  split split_obj;
75  do_split(r, split_obj);
76  }
77 
78 #if __TBB_USE_PROPORTIONAL_SPLIT_IN_BLOCKED_RANGES
79  static const bool is_splittable_in_proportion = true;
81 
83  my_pages(r.my_pages),
84  my_rows(r.my_rows),
85  my_cols(r.my_cols)
86  {
87  do_split(r, proportion);
88  }
89 #endif /* __TBB_USE_PROPORTIONAL_SPLIT_IN_BLOCKED_RANGES */
90 
92  const page_range_type& pages() const {return my_pages;}
93 
95  const row_range_type& rows() const {return my_rows;}
96 
98  const col_range_type& cols() const {return my_cols;}
99 
100 private:
101 
102  template <typename Split>
103  void do_split( blocked_range3d& r, Split& split_obj)
104  {
105  if ( my_pages.size()*double(my_rows.grainsize()) < my_rows.size()*double(my_pages.grainsize()) ) {
106  if ( my_rows.size()*double(my_cols.grainsize()) < my_cols.size()*double(my_rows.grainsize()) ) {
108  } else {
110  }
111  } else {
112  if ( my_pages.size()*double(my_cols.grainsize()) < my_cols.size()*double(my_pages.grainsize()) ) {
114  } else {
116  }
117  }
118  }
119 };
120 
121 } // namespace tbb
122 
123 #endif /* __TBB_blocked_range3d_H */
tbb::blocked_range3d::is_divisible
bool is_divisible() const
True if range is divisible into two pieces.
Definition: blocked_range3d.h:65
tbb::blocked_range3d::my_rows
row_range_type my_rows
Definition: blocked_range3d.h:37
tbb
The graph class.
Definition: serial/tbb/parallel_for.h:46
blocked_range.h
tbb::blocked_range3d::do_split
void do_split(blocked_range3d &r, Split &split_obj)
Definition: blocked_range3d.h:103
tbb::blocked_range3d::is_splittable_in_proportion
static const bool is_splittable_in_proportion
Static field to support proportional split.
Definition: blocked_range3d.h:80
tbb::blocked_range::my_begin
Value my_begin
Definition: blocked_range.h:127
tbb::blocked_range3d::blocked_range3d
blocked_range3d(PageValue page_begin, PageValue page_end, RowValue row_begin, RowValue row_end, ColValue col_begin, ColValue col_end)
Definition: blocked_range3d.h:42
tbb::blocked_range3d::empty
bool empty() const
True if range is empty.
Definition: blocked_range3d.h:59
tbb::blocked_range3d::my_pages
page_range_type my_pages
Definition: blocked_range3d.h:36
tbb::split
Dummy type that distinguishes splitting constructor from copy constructor.
Definition: tbb_stddef.h:416
tbb::blocked_range3d::blocked_range3d
blocked_range3d(blocked_range3d &r, split)
Definition: blocked_range3d.h:69
tbb::blocked_range3d::col_range_type
blocked_range< ColValue > col_range_type
Definition: blocked_range3d.h:33
tbb::blocked_range3d::row_range_type
blocked_range< RowValue > row_range_type
Definition: blocked_range3d.h:32
tbb::blocked_range3d::page_range_type
blocked_range< PageValue > page_range_type
Type for size of an iteration range.
Definition: blocked_range3d.h:31
tbb::blocked_range3d::rows
const row_range_type & rows() const
The rows of the iteration space.
Definition: blocked_range3d.h:95
tbb::blocked_range::grainsize
size_type grainsize() const
The grain size for this range.
Definition: blocked_range.h:82
tbb::blocked_range< PageValue >::size_type
std::size_t size_type
Type for size of a range.
Definition: blocked_range.h:53
tbb::blocked_range< PageValue >
tbb::blocked_range::size
size_type size() const
Size of the range.
Definition: blocked_range.h:76
tbb::blocked_range3d
A 3-dimensional range that models the Range concept.
Definition: blocked_range3d.h:28
tbb::blocked_range::is_divisible
bool is_divisible() const
True if range is divisible.
Definition: blocked_range.h:93
tbb::proportional_split
Type enables transmission of splitting proportion from partitioners to range objects.
Definition: tbb_stddef.h:426
tbb::blocked_range3d::cols
const col_range_type & cols() const
The columns of the iteration space.
Definition: blocked_range3d.h:98
tbb::blocked_range::empty
bool empty() const
True if range is empty.
Definition: blocked_range.h:89
tbb_stddef.h
tbb::blocked_range3d::my_cols
col_range_type my_cols
Definition: blocked_range3d.h:38
tbb::blocked_range3d::blocked_range3d
blocked_range3d(blocked_range3d &r, proportional_split &proportion)
Definition: blocked_range3d.h:82
tbb::blocked_range3d::blocked_range3d
blocked_range3d(PageValue page_begin, PageValue page_end, typename page_range_type::size_type page_grainsize, RowValue row_begin, RowValue row_end, typename row_range_type::size_type row_grainsize, ColValue col_begin, ColValue col_end, typename col_range_type::size_type col_grainsize)
Definition: blocked_range3d.h:50
tbb::blocked_range3d::pages
const page_range_type & pages() const
The pages of the iteration space.
Definition: blocked_range3d.h:92
tbb::blocked_range::do_split
static Value do_split(blocked_range &r, split)
Auxiliary function used by the splitting constructor.
Definition: blocked_range.h:131

Copyright © 2005-2020 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.