Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
blocked_range2d.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2005-2019 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 
18 
19 */
20 
21 #ifndef __TBB_blocked_range2d_H
22 #define __TBB_blocked_range2d_H
23 
24 #include "tbb_stddef.h"
25 #include "blocked_range.h"
26 
27 namespace tbb {
28 
30 
31 template<typename RowValue, typename ColValue=RowValue>
33 public:
37 
38 private:
39  row_range_type my_rows;
40  col_range_type my_cols;
41 
42 public:
43 
44  blocked_range2d( RowValue row_begin, RowValue row_end, typename row_range_type::size_type row_grainsize,
45  ColValue col_begin, ColValue col_end, typename col_range_type::size_type col_grainsize ) :
46  my_rows(row_begin,row_end,row_grainsize),
47  my_cols(col_begin,col_end,col_grainsize)
48  {}
49 
50  blocked_range2d( RowValue row_begin, RowValue row_end,
51  ColValue col_begin, ColValue col_end ) :
52  my_rows(row_begin,row_end),
53  my_cols(col_begin,col_end)
54  {}
55 
57  bool empty() const {
58  // Range is empty if at least one dimension is empty.
59  return my_rows.empty() || my_cols.empty();
60  }
61 
63  bool is_divisible() const {
64  return my_rows.is_divisible() || my_cols.is_divisible();
65  }
66 
68  my_rows(r.my_rows),
69  my_cols(r.my_cols)
70  {
71  split split_obj;
72  do_split(r, split_obj);
73  }
74 
75 #if __TBB_USE_PROPORTIONAL_SPLIT_IN_BLOCKED_RANGES
76  static const bool is_splittable_in_proportion = true;
78 
80  my_rows(r.my_rows),
81  my_cols(r.my_cols)
82  {
83  do_split(r, proportion);
84  }
85 #endif /* __TBB_USE_PROPORTIONAL_SPLIT_IN_BLOCKED_RANGES */
86 
88  const row_range_type& rows() const {return my_rows;}
89 
91  const col_range_type& cols() const {return my_cols;}
92 
93 private:
94 
95  template <typename Split>
96  void do_split( blocked_range2d& r, Split& split_obj )
97  {
98  if( my_rows.size()*double(my_cols.grainsize()) < my_cols.size()*double(my_rows.grainsize()) ) {
99  my_cols.my_begin = col_range_type::do_split(r.my_cols, split_obj);
100  } else {
101  my_rows.my_begin = row_range_type::do_split(r.my_rows, split_obj);
102  }
103  }
104 };
105 
106 } // namespace tbb
107 
108 #endif /* __TBB_blocked_range2d_H */
blocked_range2d(RowValue row_begin, RowValue row_end, ColValue col_begin, ColValue col_end)
void do_split(blocked_range2d &r, Split &split_obj)
A 2-dimensional range that models the Range concept.
blocked_range2d(blocked_range2d &r, split)
const col_range_type & cols() const
The columns of the iteration space.
blocked_range< RowValue > row_range_type
Type for size of an iteration range.
static const bool is_splittable_in_proportion
Static field to support proportional split.
blocked_range2d(blocked_range2d &r, proportional_split &proportion)
Type enables transmission of splitting proportion from partitioners to range objects.
Definition: tbb_stddef.h:409
row_range_type my_rows
bool is_divisible() const
True if range is divisible.
Definition: blocked_range.h:97
bool empty() const
True if range is empty.
std::size_t size_type
Type for size of a range.
Definition: blocked_range.h:57
bool empty() const
True if range is empty.
Definition: blocked_range.h:93
The graph class.
const row_range_type & rows() const
The rows of the iteration space.
size_type grainsize() const
The grain size for this range.
Definition: blocked_range.h:86
bool is_divisible() const
True if range is divisible into two pieces.
blocked_range2d(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)
col_range_type my_cols
static ColValue do_split(blocked_range &r, split)
Auxiliary function used by the splitting constructor.
blocked_range< ColValue > col_range_type
size_type size() const
Size of the range.
Definition: blocked_range.h:80
Dummy type that distinguishes splitting constructor from copy constructor.
Definition: tbb_stddef.h:399

Copyright © 2005-2019 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.