Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
batch_dim.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_BASE_BATCH_DIM_HPP_
34#define GKO_PUBLIC_CORE_BASE_BATCH_DIM_HPP_
35
36
37#include <iostream>
38
39
40#include <ginkgo/core/base/dim.hpp>
41#include <ginkgo/core/base/types.hpp>
42
43
44namespace gko {
45
46
55template <size_type Dimensionality = 2, typename DimensionType = size_type>
56struct batch_dim {
57 static constexpr size_type dimensionality = Dimensionality;
58 using dimension_type = DimensionType;
59
65 size_type get_num_batch_items() const { return num_batch_items_; }
66
73 {
74 return common_size_;
75 }
76
85 friend bool operator==(const batch_dim& x, const batch_dim& y)
86 {
87 return x.num_batch_items_ == y.num_batch_items_ &&
88 x.common_size_ == y.common_size_;
89 }
90
91
105 {
106 return !(x == y);
107 }
108
109
114 : common_size_(dim<dimensionality, dimension_type>{}),
115 num_batch_items_(0)
116 {}
117
129 : common_size_(common_size), num_batch_items_(num_batch_items)
130 {}
131
132private:
133 size_type num_batch_items_{};
134 dim<dimensionality, dimension_type> common_size_{};
135};
136
137
147template <typename DimensionType>
154
155
156} // namespace gko
157
158
159#endif // GKO_PUBLIC_CORE_BASE_BATCH_DIM_HPP_
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
batch_dim< 2, DimensionType > transpose(const batch_dim< 2, DimensionType > &input)
Returns a batch_dim object with its dimensions swapped for batched operators.
Definition batch_dim.hpp:148
A type representing the dimensions of a multidimensional batch object.
Definition batch_dim.hpp:56
batch_dim(const size_type num_batch_items, const dim< dimensionality, dimension_type > &common_size)
Creates a batch_dim object which stores a uniform size for all batch entries.
Definition batch_dim.hpp:127
friend bool operator!=(const batch_dim< Dimensionality, DimensionType > &x, const batch_dim< Dimensionality, DimensionType > &y)
Checks if two batch_dim objects are different.
Definition batch_dim.hpp:103
dim< dimensionality, dimension_type > get_common_size() const
Get the common size of the batch items.
Definition batch_dim.hpp:72
size_type get_num_batch_items() const
Get the number of batch items stored.
Definition batch_dim.hpp:65
friend bool operator==(const batch_dim &x, const batch_dim &y)
Checks if two batch_dim objects are equal.
Definition batch_dim.hpp:85
batch_dim()
The default constructor.
Definition batch_dim.hpp:113
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:55