StaticSymmetry.h
Go to the documentation of this file.
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2013 Christian Seiler <christian@iwakd.de>
5 //
6 // This Source Code Form is subject to the terms of the Mozilla
7 // Public License v. 2.0. If a copy of the MPL was not distributed
8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 
10 #ifndef EIGEN_CXX11_TENSORSYMMETRY_STATICSYMMETRY_H
11 #define EIGEN_CXX11_TENSORSYMMETRY_STATICSYMMETRY_H
12 
13 namespace Eigen {
14 
15 namespace internal {
16 
17 template<typename list> struct tensor_static_symgroup_permutate;
18 
19 template<int... nn>
21 {
22  constexpr static std::size_t N = sizeof...(nn);
23 
24  template<typename T>
25  constexpr static inline std::array<T, N> run(const std::array<T, N>& indices)
26  {
27  return {{indices[nn]...}};
28  }
29 };
30 
31 template<typename indices_, int flags_>
33 {
34  typedef indices_ indices;
35  constexpr static int flags = flags_;
36 };
37 
38 template<typename Gen, int N>
40 {
43  Gen::Flags
44  > type;
45 };
46 
47 template<int N>
49 {
52  0
53  > type;
54 };
55 
56 template<typename iib>
58 {
59  template<int... iia>
62  }
63 };
64 
65 template<typename A, typename B>
67 {
68  private:
69  typedef typename A::indices iia;
70  typedef typename B::indices iib;
71  constexpr static int ffa = A::flags;
72  constexpr static int ffb = B::flags;
73 
74  public:
75  static_assert(iia::count == iib::count, "Cannot multiply symmetry elements with different number of indices.");
76 
79  ffa ^ ffb
80  > type;
81 };
82 
83 template<typename A, typename B>
85 {
86  typedef typename A::indices iia;
87  typedef typename B::indices iib;
88  constexpr static int ffa = A::flags;
89  constexpr static int ffb = B::flags;
90  static_assert(iia::count == iib::count, "Cannot compare symmetry elements with different number of indices.");
91 
92  constexpr static bool value = is_same<iia, iib>::value;
93 
94  private:
95  /* this should be zero if they are identical, or else the tensor
96  * will be forced to be pure real, pure imaginary or even pure zero
97  */
98  constexpr static int flags_cmp_ = ffa ^ ffb;
99 
100  /* either they are not equal, then we don't care whether the flags
101  * match, or they are equal, and then we have to check
102  */
103  constexpr static bool is_zero = value && flags_cmp_ == NegationFlag;
104  constexpr static bool is_real = value && flags_cmp_ == ConjugationFlag;
105  constexpr static bool is_imag = value && flags_cmp_ == (NegationFlag | ConjugationFlag);
106 
107  public:
108  constexpr static int global_flags =
109  (is_real ? GlobalRealFlag : 0) |
110  (is_imag ? GlobalImagFlag : 0) |
111  (is_zero ? GlobalZeroFlag : 0);
112 };
113 
114 template<std::size_t NumIndices, typename... Gen>
116 {
117  typedef StaticSGroup<Gen...> type;
118  constexpr static std::size_t size = type::static_size;
119 };
120 
121 template<typename Index, std::size_t N, int... ii, int... jj>
122 constexpr static inline std::array<Index, N> tensor_static_symgroup_index_permute(std::array<Index, N> idx, internal::numeric_list<int, ii...>, internal::numeric_list<int, jj...>)
123 {
124  return {{ idx[ii]..., idx[jj]... }};
125 }
126 
127 template<typename Index, int... ii>
128 static inline std::vector<Index> tensor_static_symgroup_index_permute(std::vector<Index> idx, internal::numeric_list<int, ii...>)
129 {
130  std::vector<Index> result{{ idx[ii]... }};
131  std::size_t target_size = idx.size();
132  for (std::size_t i = result.size(); i < target_size; i++)
133  result.push_back(idx[i]);
134  return result;
135 }
136 
137 template<typename T> struct tensor_static_symgroup_do_apply;
138 
139 template<typename first, typename... next>
141 {
142  template<typename Op, typename RV, std::size_t SGNumIndices, typename Index, std::size_t NumIndices, typename... Args>
143  static inline RV run(const std::array<Index, NumIndices>& idx, RV initial, Args&&... args)
144  {
145  static_assert(NumIndices >= SGNumIndices, "Can only apply symmetry group to objects that have at least the required amount of indices.");
146  typedef typename internal::gen_numeric_list<int, NumIndices - SGNumIndices, SGNumIndices>::type remaining_indices;
147  initial = Op::run(tensor_static_symgroup_index_permute(idx, typename first::indices(), remaining_indices()), first::flags, initial, std::forward<Args>(args)...);
148  return tensor_static_symgroup_do_apply<internal::type_list<next...>>::template run<Op, RV, SGNumIndices>(idx, initial, args...);
149  }
150 
151  template<typename Op, typename RV, std::size_t SGNumIndices, typename Index, typename... Args>
152  static inline RV run(const std::vector<Index>& idx, RV initial, Args&&... args)
153  {
154  eigen_assert(idx.size() >= SGNumIndices && "Can only apply symmetry group to objects that have at least the required amount of indices.");
155  initial = Op::run(tensor_static_symgroup_index_permute(idx, typename first::indices()), first::flags, initial, std::forward<Args>(args)...);
156  return tensor_static_symgroup_do_apply<internal::type_list<next...>>::template run<Op, RV, SGNumIndices>(idx, initial, args...);
157  }
158 };
159 
160 template<EIGEN_TPL_PP_SPEC_HACK_DEF(typename, empty)>
161 struct tensor_static_symgroup_do_apply<internal::type_list<EIGEN_TPL_PP_SPEC_HACK_USE(empty)>>
162 {
163  template<typename Op, typename RV, std::size_t SGNumIndices, typename Index, std::size_t NumIndices, typename... Args>
164  static inline RV run(const std::array<Index, NumIndices>&, RV initial, Args&&...)
165  {
166  // do nothing
167  return initial;
168  }
169 
170  template<typename Op, typename RV, std::size_t SGNumIndices, typename Index, typename... Args>
171  static inline RV run(const std::vector<Index>&, RV initial, Args&&...)
172  {
173  // do nothing
174  return initial;
175  }
176 };
177 
178 } // end namespace internal
179 
180 template<typename... Gen>
182 {
190  typedef typename group_elements::type ge;
191  public:
192  constexpr inline StaticSGroup() {}
193  constexpr inline StaticSGroup(const StaticSGroup<Gen...>&) {}
194  constexpr inline StaticSGroup(StaticSGroup<Gen...>&&) {}
195 
196  template<typename Op, typename RV, typename Index, std::size_t N, typename... Args>
197  static inline RV apply(const std::array<Index, N>& idx, RV initial, Args&&... args)
198  {
199  return internal::tensor_static_symgroup_do_apply<ge>::template run<Op, RV, NumIndices>(idx, initial, args...);
200  }
201 
202  template<typename Op, typename RV, typename Index, typename... Args>
203  static inline RV apply(const std::vector<Index>& idx, RV initial, Args&&... args)
204  {
205  eigen_assert(idx.size() == NumIndices);
206  return internal::tensor_static_symgroup_do_apply<ge>::template run<Op, RV, NumIndices>(idx, initial, args...);
207  }
208 
209  constexpr static std::size_t static_size = ge::count;
210 
211  constexpr static inline std::size_t size() {
212  return ge::count;
213  }
214  constexpr static inline int globalFlags() { return group_elements::global_flags; }
215 
216  template<typename Tensor_, typename... IndexTypes>
217  inline internal::tensor_symmetry_value_setter<Tensor_, StaticSGroup<Gen...>> operator()(Tensor_& tensor, typename Tensor_::Index firstIndex, IndexTypes... otherIndices) const
218  {
219  static_assert(sizeof...(otherIndices) + 1 == Tensor_::NumIndices, "Number of indices used to access a tensor coefficient must be equal to the rank of the tensor.");
220  return operator()(tensor, std::array<typename Tensor_::Index, Tensor_::NumIndices>{{firstIndex, otherIndices...}});
221  }
222 
223  template<typename Tensor_>
224  inline internal::tensor_symmetry_value_setter<Tensor_, StaticSGroup<Gen...>> operator()(Tensor_& tensor, std::array<typename Tensor_::Index, Tensor_::NumIndices> const& indices) const
225  {
226  return internal::tensor_symmetry_value_setter<Tensor_, StaticSGroup<Gen...>>(tensor, *this, indices);
227  }
228 };
229 
230 } // end namespace Eigen
231 
232 #endif // EIGEN_CXX11_TENSORSYMMETRY_STATICSYMMETRY_H
233 
234 /*
235  * kate: space-indent on; indent-width 2; mixedindent off; indent-mode cstyle;
236  */
gtsam.examples.DogLegOptimizerExample.int
int
Definition: DogLegOptimizerExample.py:111
Eigen
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
Eigen::GlobalRealFlag
@ GlobalRealFlag
Definition: Symmetry.h:21
Eigen::internal::tensor_static_symgroup_identity_ctor
Definition: StaticSymmetry.h:48
Eigen::GlobalZeroFlag
@ GlobalZeroFlag
Definition: Symmetry.h:23
Eigen::internal::tensor_static_symgroup_equality::flags_cmp_
constexpr static int flags_cmp_
Definition: StaticSymmetry.h:98
Eigen::internal::tensor_static_symgroup_equality
Definition: StaticSymmetry.h:84
Eigen::StaticSGroup::group_elements
internal::group_theory::enumerate_group_elements< internal::tensor_static_symgroup_multiply, internal::tensor_static_symgroup_equality, typename internal::tensor_static_symgroup_identity_ctor< NumIndices >::type, internal::type_list< typename internal::tensor_static_symgroup_element_ctor< Gen, NumIndices >::type... > > group_elements
Definition: StaticSymmetry.h:189
Eigen::StaticSGroup::operator()
internal::tensor_symmetry_value_setter< Tensor_, StaticSGroup< Gen... > > operator()(Tensor_ &tensor, typename Tensor_::Index firstIndex, IndexTypes... otherIndices) const
Definition: StaticSymmetry.h:217
Eigen::internal::tensor_static_symgroup_multiply::iia
A::indices iia
Definition: StaticSymmetry.h:69
eigen_assert
#define eigen_assert(x)
Definition: Macros.h:1037
initial
Values initial
Definition: OdometryOptimize.cpp:2
Eigen::StaticSGroup::StaticSGroup
constexpr StaticSGroup()
Definition: StaticSymmetry.h:192
Eigen::internal::tensor_static_symgroup_element_ctor::type
tensor_static_symgroup_element< typename gen_numeric_list_swapped_pair< int, N, Gen::One, Gen::Two >::type, Gen::Flags > type
Definition: StaticSymmetry.h:44
Eigen::internal::tensor_symmetry_value_setter
Definition: Symmetry.h:297
Eigen::internal::tensor_static_symgroup_element::indices
indices_ indices
Definition: StaticSymmetry.h:34
Eigen::StaticSGroup::apply
static RV apply(const std::array< Index, N > &idx, RV initial, Args &&... args)
Definition: StaticSymmetry.h:197
type
Definition: pytypes.h:1525
Eigen::StaticSGroup::NumIndices
constexpr static std::size_t NumIndices
Definition: StaticSymmetry.h:183
Eigen::StaticSGroup::size
constexpr static std::size_t size()
Definition: StaticSymmetry.h:211
Eigen::internal::tensor_static_symgroup_multiply::ffb
constexpr static int ffb
Definition: StaticSymmetry.h:72
Eigen::internal::group_theory::enumerate_group_elements
Definition: TemplateGroupTheory.h:648
Eigen::internal::tensor_static_symgroup_equality::ffa
constexpr static int ffa
Definition: StaticSymmetry.h:88
result
Values result
Definition: OdometryOptimize.cpp:8
Eigen::internal::gen_numeric_list_swapped_pair
Definition: CXX11Meta.h:57
test_eigen_tensor.indices
indices
Definition: test_eigen_tensor.py:33
Eigen::StaticSGroup::StaticSGroup
constexpr StaticSGroup(StaticSGroup< Gen... > &&)
Definition: StaticSymmetry.h:194
Eigen::internal::tensor_static_symgroup_equality::iib
B::indices iib
Definition: StaticSymmetry.h:87
Eigen::internal::tensor_static_symgroup_equality::iia
A::indices iia
Definition: StaticSymmetry.h:86
Eigen::NegationFlag
@ NegationFlag
Definition: Symmetry.h:16
Eigen::internal::tensor_static_symgroup_equality::is_real
constexpr static bool is_real
Definition: StaticSymmetry.h:104
Eigen::internal::tensor_symmetry_num_indices
Definition: Symmetry.h:33
Eigen::internal::tensor_static_symgroup_multiply_helper::helper
constexpr static numeric_list< int, get< iia, iib >::value... > helper(numeric_list< int, iia... >)
Definition: StaticSymmetry.h:60
Eigen::internal::tensor_static_symgroup_do_apply< internal::type_list< first, next... > >::run
static RV run(const std::vector< Index > &idx, RV initial, Args &&... args)
Definition: StaticSymmetry.h:152
Eigen::internal::group_theory::enumerate_group_elements_noid< Multiply, Equality, id, strip_identities< Equality, id, _generators >::type, strip_identities< Equality, id, _generators >::global_flags >::global_flags
constexpr static int global_flags
Definition: TemplateGroupTheory.h:606
Eigen::internal::tensor_static_symgroup_do_apply< internal::type_list< EIGEN_TPL_PP_SPEC_HACK_USE(empty)> >::run
static RV run(const std::vector< Index > &, RV initial, Args &&...)
Definition: StaticSymmetry.h:171
Eigen::StaticSGroup::StaticSGroup
constexpr StaticSGroup(const StaticSGroup< Gen... > &)
Definition: StaticSymmetry.h:193
Eigen::StaticSGroup
Static symmetry group.
Definition: StaticSymmetry.h:181
Eigen::internal::tensor_static_symgroup_do_apply< internal::type_list< EIGEN_TPL_PP_SPEC_HACK_USE(empty)> >::run
static RV run(const std::array< Index, NumIndices > &, RV initial, Args &&...)
Definition: StaticSymmetry.h:164
Eigen::internal::first
EIGEN_CONSTEXPR Index first(const T &x) EIGEN_NOEXCEPT
Definition: IndexedViewHelper.h:81
Eigen::internal::gen_numeric_list
Definition: CXX11Meta.h:51
gtsam.examples.DogLegOptimizerExample.run
def run(args)
Definition: DogLegOptimizerExample.py:21
Eigen::internal::tensor_static_symgroup_equality::is_zero
constexpr static bool is_zero
Definition: StaticSymmetry.h:103
Eigen::StaticSGroup::ge
group_elements::type ge
Definition: StaticSymmetry.h:190
Eigen::internal::tensor_static_symgroup_multiply
Definition: StaticSymmetry.h:66
Eigen::internal::tensor_static_symgroup_equality::ffb
constexpr static int ffb
Definition: StaticSymmetry.h:89
Eigen::StaticSGroup::apply
static RV apply(const std::vector< Index > &idx, RV initial, Args &&... args)
Definition: StaticSymmetry.h:203
Eigen::internal::tensor_static_symgroup_multiply::ffa
constexpr static int ffa
Definition: StaticSymmetry.h:71
size_t
std::size_t size_t
Definition: wrap/pybind11/include/pybind11/detail/common.h:490
Eigen::StaticSGroup::operator()
internal::tensor_symmetry_value_setter< Tensor_, StaticSGroup< Gen... > > operator()(Tensor_ &tensor, std::array< typename Tensor_::Index, Tensor_::NumIndices > const &indices) const
Definition: StaticSymmetry.h:224
Eigen::internal::type_list
Definition: CXX11Meta.h:29
Eigen::internal::numeric_list
Definition: CXX11Meta.h:35
Eigen::internal::tensor_static_symgroup
Definition: StaticSymmetry.h:115
Eigen::internal::tensor_static_symgroup_multiply::iib
B::indices iib
Definition: StaticSymmetry.h:70
Eigen::internal::tensor_static_symgroup_do_apply
Definition: StaticSymmetry.h:137
Eigen::internal::tensor_static_symgroup::type
StaticSGroup< Gen... > type
Definition: StaticSymmetry.h:117
Eigen::internal::tensor_static_symgroup_element_ctor
Definition: StaticSymmetry.h:39
args
Definition: pytypes.h:2210
Eigen::internal::tensor_static_symgroup_do_apply< internal::type_list< first, next... > >::run
static RV run(const std::array< Index, NumIndices > &idx, RV initial, Args &&... args)
Definition: StaticSymmetry.h:143
Eigen::internal::tensor_static_symgroup_permutate
Definition: StaticSymmetry.h:17
Eigen::internal::group_theory::enumerate_group_elements_noid< Multiply, Equality, id, strip_identities< Equality, id, _generators >::type, strip_identities< Equality, id, _generators >::global_flags >::type
_helper::type type
Definition: TemplateGroupTheory.h:605
Eigen::StaticSGroup::globalFlags
constexpr static int globalFlags()
Definition: StaticSymmetry.h:214
initial
Definition: testScenarioRunner.cpp:148
Eigen::internal::tensor_static_symgroup_identity_ctor::type
tensor_static_symgroup_element< typename gen_numeric_list< int, N >::type, 0 > type
Definition: StaticSymmetry.h:53
Eigen::internal::is_same
Definition: Meta.h:148
Eigen::internal::tensor_static_symgroup_equality::value
constexpr static bool value
Definition: StaticSymmetry.h:92
N
#define N
Definition: igam.h:9
internal
Definition: BandTriangularSolver.h:13
Eigen::internal::tensor_static_symgroup::size
constexpr static std::size_t size
Definition: StaticSymmetry.h:118
Eigen::internal::tensor_static_symgroup_element::flags
constexpr static int flags
Definition: StaticSymmetry.h:35
Eigen::internal::tensor_static_symgroup_multiply_helper
Definition: StaticSymmetry.h:57
Eigen::internal::tensor_static_symgroup_permutate< numeric_list< int, nn... > >::run
constexpr static std::array< T, N > run(const std::array< T, N > &indices)
Definition: StaticSymmetry.h:25
Eigen::internal::tensor_static_symgroup_index_permute
constexpr static std::array< Index, N > tensor_static_symgroup_index_permute(std::array< Index, N > idx, internal::numeric_list< int, ii... >, internal::numeric_list< int, jj... >)
Definition: StaticSymmetry.h:122
nn
idx_t * nn
Definition: include/metis.h:207
Eigen::internal::tensor_static_symgroup_multiply::type
tensor_static_symgroup_element< decltype(tensor_static_symgroup_multiply_helper< iib >::helper(iia())), ffa ^ ffb > type
Definition: StaticSymmetry.h:75
Eigen::internal::tensor_static_symgroup_equality::is_imag
constexpr static bool is_imag
Definition: StaticSymmetry.h:105
Eigen::GlobalImagFlag
@ GlobalImagFlag
Definition: Symmetry.h:22
test_callbacks.value
value
Definition: test_callbacks.py:160
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9
Eigen::ConjugationFlag
@ ConjugationFlag
Definition: Symmetry.h:17
Eigen::StaticSGroup::static_size
constexpr static std::size_t static_size
Definition: StaticSymmetry.h:209
Eigen::internal::tensor_static_symgroup_element
Definition: StaticSymmetry.h:32
Eigen::internal::tensor_static_symgroup_equality::global_flags
constexpr static int global_flags
Definition: StaticSymmetry.h:108
Eigen::Index
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:36:24