xtensor
Loading...
Searching...
No Matches
xfixed.hpp
1/***************************************************************************
2 * Copyright (c) Johan Mabille, Sylvain Corlay and Wolf Vollprecht *
3 * Copyright (c) QuantStack *
4 * *
5 * Distributed under the terms of the BSD 3-Clause License. *
6 * *
7 * The full license is in the file LICENSE, distributed with this software. *
8 ****************************************************************************/
9
10#ifndef XTENSOR_FIXED_HPP
11#define XTENSOR_FIXED_HPP
12
13#include <algorithm>
14#include <array>
15#include <cstddef>
16#include <utility>
17#include <vector>
18
19#include <xtl/xsequence.hpp>
20
21#include "xcontainer.hpp"
22#include "xsemantic.hpp"
23#include "xstorage.hpp"
24#include "xstrides.hpp"
25#include "xtensor_config.hpp"
26
27namespace xtl
28{
29 namespace detail
30 {
31 template <class T, std::size_t N>
32 struct sequence_builder<xt::const_array<T, N>>
33 {
34 using sequence_type = xt::const_array<T, N>;
35 using value_type = typename sequence_type::value_type;
36 using size_type = typename sequence_type::size_type;
37
38 inline static sequence_type make(size_type /*size*/, value_type /*v*/)
39 {
40 return sequence_type();
41 }
42 };
43 }
44}
45
46namespace xt
47{
48
49 /**********************
50 * xfixed declaration *
51 **********************/
52
53 template <class ET, class S, layout_type L, bool SH, class Tag>
54 class xfixed_container;
55
56 namespace detail
57 {
58 /**************************************************************************************
59 The following is something we can currently only dream about -- for when we drop
60 support for a lot of the old compilers (e.g. GCC 4.9, MSVC 2017 ;)
61
62 template <class T>
63 constexpr std::size_t calculate_stride(T& shape, std::size_t idx, layout_type L)
64 {
65 if (shape[idx] == 1)
66 {
67 return std::size_t(0);
68 }
69
70 std::size_t data_size = 1;
71 std::size_t stride = 1;
72 if (L == layout_type::row_major)
73 {
74 // because we have a integer sequence that counts
75 // from 0 to sz - 1, we need to "invert" idx here
76 idx = shape.size() - idx;
77 for (std::size_t i = idx; i != 0; --i)
78 {
79 stride = data_size;
80 data_size = stride * shape[i - 1];
81 }
82 }
83 else
84 {
85 for (std::size_t i = 0; i < idx + 1; ++i)
86 {
87 stride = data_size;
88 data_size = stride * shape[i];
89 }
90 }
91 return stride;
92 }
93
94 *****************************************************************************************/
95
96 template <layout_type L, std::size_t I, std::size_t... X>
97 struct calculate_stride;
98
99 template <std::size_t I, std::size_t Y, std::size_t... X>
100 struct calculate_stride<layout_type::column_major, I, Y, X...>
101 {
102 static constexpr std::ptrdiff_t value = Y
103 * calculate_stride<layout_type::column_major, I - 1, X...>::value;
104 };
105
106 template <std::size_t Y, std::size_t... X>
107 struct calculate_stride<layout_type::column_major, 0, Y, X...>
108 {
109 static constexpr std::ptrdiff_t value = 1;
110 };
111
112 template <std::size_t I, std::size_t... X>
113 struct calculate_stride_row_major
114 {
115 static constexpr std::ptrdiff_t value = at<sizeof...(X) - I, X...>::value
116 * calculate_stride_row_major<I - 1, X...>::value;
117 };
118
119 template <std::size_t... X>
120 struct calculate_stride_row_major<0, X...>
121 {
122 static constexpr std::ptrdiff_t value = 1;
123 };
124
125 template <std::size_t I, std::size_t... X>
126 struct calculate_stride<layout_type::row_major, I, X...>
127 {
128 static constexpr std::ptrdiff_t value = calculate_stride_row_major<sizeof...(X) - I - 1, X...>::value;
129 };
130
131 namespace workaround
132 {
133 template <layout_type L, size_t I, class SEQ>
134 struct computed_strides;
135
136 template <layout_type L, size_t I, size_t... X>
137 struct computed_strides<L, I, std::index_sequence<X...>>
138 {
139 static constexpr std::ptrdiff_t value = calculate_stride<L, I, X...>::value;
140 };
141
142 template <layout_type L, size_t I, class SEQ>
143 constexpr std::ptrdiff_t get_computed_strides(bool cond)
144 {
145 return cond ? 0 : computed_strides<L, I, SEQ>::value;
146 }
147 }
148
149 template <layout_type L, class R, std::size_t... X, std::size_t... I>
150 constexpr R get_strides_impl(const xt::fixed_shape<X...>& shape, std::index_sequence<I...>)
151 {
152 static_assert(
153 (L == layout_type::row_major) || (L == layout_type::column_major),
154 "Layout not supported for fixed array"
155 );
156#if (_MSC_VER >= 1910)
157 using temp_type = std::index_sequence<X...>;
158 return R({workaround::get_computed_strides<L, I, temp_type>(shape[I] == 1)...});
159#else
160 return R({shape[I] == 1 ? 0 : calculate_stride<L, I, X...>::value...});
161#endif
162 }
163
164 template <class S, class T, std::size_t... I>
165 constexpr T get_backstrides_impl(const S& shape, const T& strides, std::index_sequence<I...>)
166 {
167 return T({(strides[I] * std::ptrdiff_t(shape[I] - 1))...});
168 }
169
170 template <std::size_t... X>
171 struct fixed_compute_size_impl;
172
173 template <std::size_t Y, std::size_t... X>
174 struct fixed_compute_size_impl<Y, X...>
175 {
176 static constexpr std::size_t value = Y * fixed_compute_size_impl<X...>::value;
177 };
178
179 template <std::size_t X>
180 struct fixed_compute_size_impl<X>
181 {
182 static constexpr std::size_t value = X;
183 };
184
185 template <>
186 struct fixed_compute_size_impl<>
187 {
188 // support for 0D xtensor fixed (empty shape = xshape<>)
189 static constexpr std::size_t value = 1;
190 };
191
192 // TODO unify with constexpr compute_size when dropping MSVC 2015
193 template <class T>
194 struct fixed_compute_size;
195
196 template <std::size_t... X>
197 struct fixed_compute_size<xt::fixed_shape<X...>>
198 {
199 static constexpr std::size_t value = fixed_compute_size_impl<X...>::value;
200 };
201
202 template <class V, std::size_t... X>
203 struct get_init_type_impl;
204
205 template <class V, std::size_t Y>
206 struct get_init_type_impl<V, Y>
207 {
208 using type = V[Y];
209 };
210
211 template <class V>
212 struct get_init_type_impl<V>
213 {
214 using type = V[1];
215 };
216
217 template <class V, std::size_t Y, std::size_t... X>
218 struct get_init_type_impl<V, Y, X...>
219 {
220 using tmp_type = typename get_init_type_impl<V, X...>::type;
221 using type = tmp_type[Y];
222 };
223 }
224
225 template <layout_type L, class R, std::size_t... X>
226 constexpr R get_strides(const fixed_shape<X...>& shape) noexcept
227 {
228 return detail::get_strides_impl<L, R>(shape, std::make_index_sequence<sizeof...(X)>{});
229 }
230
231 template <class S, class T>
232 constexpr T get_backstrides(const S& shape, const T& strides) noexcept
233 {
234 return detail::get_backstrides_impl(shape, strides, std::make_index_sequence<std::tuple_size<T>::value>{});
235 }
236
237 template <class V, class S>
238 struct get_init_type;
239
240 template <class V, std::size_t... X>
241 struct get_init_type<V, fixed_shape<X...>>
242 {
243 using type = typename detail::get_init_type_impl<V, X...>::type;
244 };
245
246 template <class V, class S>
247 using get_init_type_t = typename get_init_type<V, S>::type;
248
249 template <class ET, class S, layout_type L, bool SH, class Tag>
250 struct xcontainer_inner_types<xfixed_container<ET, S, L, SH, Tag>>
251 {
252 using shape_type = S;
253 using inner_shape_type = typename S::cast_type;
254 using strides_type = get_strides_t<inner_shape_type>;
255 using inner_strides_type = strides_type;
256 using backstrides_type = inner_strides_type;
257 using inner_backstrides_type = backstrides_type;
258
259 // NOTE: 0D (S::size() == 0) results in storage for 1 element (scalar)
260#if defined(_MSC_VER) && _MSC_VER < 1910 && !defined(_WIN64)
261 // WORKAROUND FOR MSVC 2015 32 bit, fallback to unaligned container for 0D scalar case
262 using storage_type = std::array<ET, detail::fixed_compute_size<S>::value>;
263#else
264 using storage_type = aligned_array<ET, detail::fixed_compute_size<S>::value>;
265#endif
266
267 using reference = typename storage_type::reference;
268 using const_reference = typename storage_type::const_reference;
269 using size_type = typename storage_type::size_type;
270 using temporary_type = xfixed_container<ET, S, L, SH, Tag>;
271 static constexpr layout_type layout = L;
272 };
273
274 template <class ET, class S, layout_type L, bool SH, class Tag>
275 struct xiterable_inner_types<xfixed_container<ET, S, L, SH, Tag>>
276 : xcontainer_iterable_types<xfixed_container<ET, S, L, SH, Tag>>
277 {
278 };
279
295 template <class ET, class S, layout_type L, bool SH, class Tag>
296 class xfixed_container : public xcontainer<xfixed_container<ET, S, L, SH, Tag>>,
297 public xcontainer_semantic<xfixed_container<ET, S, L, SH, Tag>>
298 {
299 public:
300
301 using self_type = xfixed_container<ET, S, L, SH, Tag>;
302 using base_type = xcontainer<self_type>;
303 using semantic_base = xcontainer_semantic<self_type>;
304
305 using storage_type = typename base_type::storage_type;
306 using value_type = typename base_type::value_type;
307 using reference = typename base_type::reference;
308 using const_reference = typename base_type::const_reference;
309 using pointer = typename base_type::pointer;
310 using const_pointer = typename base_type::const_pointer;
311 using shape_type = typename base_type::shape_type;
312 using inner_shape_type = typename base_type::inner_shape_type;
313 using strides_type = typename base_type::strides_type;
314 using backstrides_type = typename base_type::backstrides_type;
315 using inner_backstrides_type = typename base_type::inner_backstrides_type;
316 using inner_strides_type = typename base_type::inner_strides_type;
317 using temporary_type = typename semantic_base::temporary_type;
318 using expression_tag = Tag;
319
320 static constexpr std::size_t N = std::tuple_size<shape_type>::value;
321 static constexpr std::size_t rank = N;
322
323 xfixed_container() = default;
324 xfixed_container(const value_type& v);
325 explicit xfixed_container(const inner_shape_type& shape, layout_type l = L);
326 explicit xfixed_container(const inner_shape_type& shape, value_type v, layout_type l = L);
327
328 // remove this enable_if when removing the other value_type constructor
329 template <class IX = std::integral_constant<std::size_t, N>, class EN = std::enable_if_t<IX::value != 0, int>>
330 xfixed_container(nested_initializer_list_t<value_type, N> t);
331
332 ~xfixed_container() = default;
333
334 xfixed_container(const xfixed_container&) = default;
335 xfixed_container& operator=(const xfixed_container&) = default;
336
337 xfixed_container(xfixed_container&&) = default;
338 xfixed_container& operator=(xfixed_container&&) = default;
339
340 template <class E>
341 xfixed_container(const xexpression<E>& e);
342
343 template <class E>
344 xfixed_container& operator=(const xexpression<E>& e);
345
346 template <class ST = std::array<std::size_t, N>>
347 static xfixed_container from_shape(ST&& /*s*/);
348
349 template <class ST = std::array<std::size_t, N>>
350 void resize(ST&& shape, bool force = false) const;
351 template <class ST = shape_type>
352 void resize(ST&& shape, layout_type l) const;
353 template <class ST = shape_type>
354 void resize(ST&& shape, const strides_type& strides) const;
355
356 template <class ST = std::array<std::size_t, N>>
357 const auto& reshape(ST&& shape, layout_type layout = L) const;
358
359 template <class ST>
360 bool broadcast_shape(ST& s, bool reuse_cache = false) const;
361
362 constexpr layout_type layout() const noexcept;
363 bool is_contiguous() const noexcept;
364
365 private:
366
367 storage_type m_storage;
368
369 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_shape_type m_shape = S();
370 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_strides_type m_strides = get_strides<L, inner_strides_type>(S());
371 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_backstrides_type
372 m_backstrides = get_backstrides(m_shape, m_strides);
373
374 storage_type& storage_impl() noexcept;
375 const storage_type& storage_impl() const noexcept;
376
377 XTENSOR_CONSTEXPR_RETURN const inner_shape_type& shape_impl() const noexcept;
378 XTENSOR_CONSTEXPR_RETURN const inner_strides_type& strides_impl() const noexcept;
379 XTENSOR_CONSTEXPR_RETURN const inner_backstrides_type& backstrides_impl() const noexcept;
380
381 friend class xcontainer<xfixed_container<ET, S, L, SH, Tag>>;
382 };
383
384#ifdef XTENSOR_HAS_CONSTEXPR_ENHANCED
385 // Out of line definitions to prevent linker errors prior to C++17
386 template <class ET, class S, layout_type L, bool SH, class Tag>
387 constexpr
388 typename xfixed_container<ET, S, L, SH, Tag>::inner_shape_type xfixed_container<ET, S, L, SH, Tag>::m_shape;
389
390 template <class ET, class S, layout_type L, bool SH, class Tag>
391 constexpr
392 typename xfixed_container<ET, S, L, SH, Tag>::inner_strides_type xfixed_container<ET, S, L, SH, Tag>::m_strides;
393
394 template <class ET, class S, layout_type L, bool SH, class Tag>
395 constexpr typename xfixed_container<ET, S, L, SH, Tag>::inner_backstrides_type
396 xfixed_container<ET, S, L, SH, Tag>::m_backstrides;
397#endif
398
399 /****************************************
400 * xfixed_container_adaptor declaration *
401 ****************************************/
402
403 template <class EC, class S, layout_type L, bool SH, class Tag>
404 class xfixed_adaptor;
405
406 template <class EC, class S, layout_type L, bool SH, class Tag>
407 struct xcontainer_inner_types<xfixed_adaptor<EC, S, L, SH, Tag>>
408 {
409 using storage_type = std::remove_reference_t<EC>;
410 using reference = typename storage_type::reference;
411 using const_reference = typename storage_type::const_reference;
412 using size_type = typename storage_type::size_type;
413 using shape_type = S;
414 using inner_shape_type = typename S::cast_type;
415 using strides_type = get_strides_t<inner_shape_type>;
416 using backstrides_type = strides_type;
417 using inner_strides_type = strides_type;
418 using inner_backstrides_type = backstrides_type;
419 using temporary_type = xfixed_container<typename storage_type::value_type, S, L, SH, Tag>;
420 static constexpr layout_type layout = L;
421 };
422
423 template <class EC, class S, layout_type L, bool SH, class Tag>
424 struct xiterable_inner_types<xfixed_adaptor<EC, S, L, SH, Tag>>
425 : xcontainer_iterable_types<xfixed_adaptor<EC, S, L, SH, Tag>>
426 {
427 };
428
445 template <class EC, class S, layout_type L, bool SH, class Tag>
446 class xfixed_adaptor : public xcontainer<xfixed_adaptor<EC, S, L, SH, Tag>>,
447 public xcontainer_semantic<xfixed_adaptor<EC, S, L, SH, Tag>>
448 {
449 public:
450
451 using container_closure_type = EC;
452
453 using self_type = xfixed_adaptor<EC, S, L, SH, Tag>;
454 using base_type = xcontainer<self_type>;
455 using semantic_base = xcontainer_semantic<self_type>;
456 using storage_type = typename base_type::storage_type;
457 using shape_type = typename base_type::shape_type;
458 using strides_type = typename base_type::strides_type;
459 using backstrides_type = typename base_type::backstrides_type;
460 using inner_shape_type = typename base_type::inner_shape_type;
461 using inner_strides_type = typename base_type::inner_strides_type;
462 using inner_backstrides_type = typename base_type::inner_backstrides_type;
463 using temporary_type = typename semantic_base::temporary_type;
464 using expression_tag = Tag;
465
466 static constexpr std::size_t N = S::size();
467
468 xfixed_adaptor(storage_type&& data);
469 xfixed_adaptor(const storage_type& data);
470
471 template <class D>
472 xfixed_adaptor(D&& data);
473
474 ~xfixed_adaptor() = default;
475
476 xfixed_adaptor(const xfixed_adaptor&) = default;
477 xfixed_adaptor& operator=(const xfixed_adaptor&);
478
479 xfixed_adaptor(xfixed_adaptor&&) = default;
480 xfixed_adaptor& operator=(xfixed_adaptor&&);
481 xfixed_adaptor& operator=(temporary_type&&);
482
483 template <class E>
484 xfixed_adaptor& operator=(const xexpression<E>& e);
485
486 template <class ST = std::array<std::size_t, N>>
487 void resize(ST&& shape, bool force = false) const;
488 template <class ST = shape_type>
489 void resize(ST&& shape, layout_type l) const;
490 template <class ST = shape_type>
491 void resize(ST&& shape, const strides_type& strides) const;
492
493 template <class ST = std::array<std::size_t, N>>
494 const auto& reshape(ST&& shape, layout_type layout = L) const;
495
496 template <class ST>
497 bool broadcast_shape(ST& s, bool reuse_cache = false) const;
498
499 constexpr layout_type layout() const noexcept;
500 bool is_contiguous() const noexcept;
501
502 private:
503
504 container_closure_type m_storage;
505
506 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_shape_type m_shape = S();
507 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_strides_type m_strides = get_strides<L, inner_strides_type>(S());
508 XTENSOR_CONSTEXPR_ENHANCED_STATIC inner_backstrides_type
509 m_backstrides = get_backstrides(m_shape, m_strides);
510
511 storage_type& storage_impl() noexcept;
512 const storage_type& storage_impl() const noexcept;
513
514 XTENSOR_CONSTEXPR_RETURN const inner_shape_type& shape_impl() const noexcept;
515 XTENSOR_CONSTEXPR_RETURN const inner_strides_type& strides_impl() const noexcept;
516 XTENSOR_CONSTEXPR_RETURN const inner_backstrides_type& backstrides_impl() const noexcept;
517
518 friend class xcontainer<xfixed_adaptor<EC, S, L, SH, Tag>>;
519 };
520
521#ifdef XTENSOR_HAS_CONSTEXPR_ENHANCED
522 // Out of line definitions to prevent linker errors prior to C++17
523 template <class EC, class S, layout_type L, bool SH, class Tag>
524 constexpr
525 typename xfixed_adaptor<EC, S, L, SH, Tag>::inner_shape_type xfixed_adaptor<EC, S, L, SH, Tag>::m_shape;
526
527 template <class EC, class S, layout_type L, bool SH, class Tag>
528 constexpr
529 typename xfixed_adaptor<EC, S, L, SH, Tag>::inner_strides_type xfixed_adaptor<EC, S, L, SH, Tag>::m_strides;
530
531 template <class EC, class S, layout_type L, bool SH, class Tag>
532 constexpr typename xfixed_adaptor<EC, S, L, SH, Tag>::inner_backstrides_type
533 xfixed_adaptor<EC, S, L, SH, Tag>::m_backstrides;
534#endif
535
536 /************************************
537 * xfixed_container implementation *
538 ************************************/
539
544
553 template <class ET, class S, layout_type L, bool SH, class Tag>
554 inline xfixed_container<ET, S, L, SH, Tag>::xfixed_container(const inner_shape_type& shape, layout_type l)
555 {
556 (void) (shape);
557 (void) (l);
558 XTENSOR_ASSERT(shape.size() == N && std::equal(shape.begin(), shape.end(), m_shape.begin()));
559 XTENSOR_ASSERT(L == l);
560 }
561
562 template <class ET, class S, layout_type L, bool SH, class Tag>
563 inline xfixed_container<ET, S, L, SH, Tag>::xfixed_container(const value_type& v)
564 {
565 if (this->size() != 1)
566 {
567 XTENSOR_THROW(std::runtime_error, "wrong shape for scalar assignment (has to be xshape<>).");
568 }
569 m_storage[0] = v;
570 }
571
581 template <class ET, class S, layout_type L, bool SH, class Tag>
582 inline xfixed_container<ET, S, L, SH, Tag>::xfixed_container(
583 const inner_shape_type& shape,
584 value_type v,
585 layout_type l
586 )
587 {
588 (void) (shape);
589 (void) (l);
590 XTENSOR_ASSERT(shape.size() == N && std::equal(shape.begin(), shape.end(), m_shape.begin()));
591 XTENSOR_ASSERT(L == l);
592 std::fill(m_storage.begin(), m_storage.end(), v);
593 }
594
595 namespace detail
596 {
597 template <std::size_t X>
598 struct check_initializer_list_shape
599 {
600 template <class T, class S>
601 static bool run(const T& t, const S& shape)
602 {
603 std::size_t IX = shape.size() - X;
604 bool result = (shape[IX] == t.size());
605 for (std::size_t i = 0; i < shape[IX]; ++i)
606 {
607 result = result && check_initializer_list_shape<X - 1>::run(t.begin()[i], shape);
608 }
609 return result;
610 }
611 };
612
613 template <>
614 struct check_initializer_list_shape<0>
615 {
616 template <class T, class S>
617 static bool run(const T& /*t*/, const S& /*shape*/)
618 {
619 return true;
620 }
621 };
622 }
623
624 template <class ET, class S, layout_type L, bool SH, class Tag>
625 template <class ST>
626 inline xfixed_container<ET, S, L, SH, Tag> xfixed_container<ET, S, L, SH, Tag>::from_shape(ST&& shape)
627 {
628 (void) shape;
629 self_type tmp;
630 XTENSOR_ASSERT(shape.size() == N && std::equal(shape.begin(), shape.end(), tmp.shape().begin()));
631 return tmp;
632 }
633
641 template <class ET, class S, layout_type L, bool SH, class Tag>
642 template <class IX, class EN>
643 inline xfixed_container<ET, S, L, SH, Tag>::xfixed_container(nested_initializer_list_t<value_type, N> t)
644 {
645 XTENSOR_ASSERT_MSG(
646 detail::check_initializer_list_shape<N>::run(t, this->shape()) == true,
647 "initializer list shape does not match fixed shape"
648 );
649 constexpr auto tmp = layout_type::row_major;
650 L == tmp ? nested_copy(m_storage.begin(), t) : nested_copy(this->template begin<tmp>(), t);
651 }
652
654
662 template <class ET, class S, layout_type L, bool SH, class Tag>
663 template <class E>
664 inline xfixed_container<ET, S, L, SH, Tag>::xfixed_container(const xexpression<E>& e)
665 {
666 semantic_base::assign(e);
667 }
668
672 template <class ET, class S, layout_type L, bool SH, class Tag>
673 template <class E>
674 inline auto xfixed_container<ET, S, L, SH, Tag>::operator=(const xexpression<E>& e) -> self_type&
675 {
676 return semantic_base::operator=(e);
677 }
678
680
685 template <class ET, class S, layout_type L, bool SH, class Tag>
686 template <class ST>
687 inline void xfixed_container<ET, S, L, SH, Tag>::resize(ST&& shape, bool) const
688 {
689 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
690 XTENSOR_ASSERT(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size());
691 }
692
697 template <class ET, class S, layout_type L, bool SH, class Tag>
698 template <class ST>
699 inline void xfixed_container<ET, S, L, SH, Tag>::resize(ST&& shape, layout_type l) const
700 {
701 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
702 (void) (l);
703 XTENSOR_ASSERT(
704 std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size() && L == l
705 );
706 }
707
712 template <class ET, class S, layout_type L, bool SH, class Tag>
713 template <class ST>
714 inline void xfixed_container<ET, S, L, SH, Tag>::resize(ST&& shape, const strides_type& strides) const
715 {
716 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
717 (void) (strides);
718 XTENSOR_ASSERT(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size());
719 XTENSOR_ASSERT(
720 std::equal(strides.begin(), strides.end(), m_strides.begin()) && strides.size() == m_strides.size()
721 );
722 }
723
727 template <class ET, class S, layout_type L, bool SH, class Tag>
728 template <class ST>
729 inline const auto& xfixed_container<ET, S, L, SH, Tag>::reshape(ST&& shape, layout_type layout) const
730 {
731 if (!(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size()
732 && layout == L))
733 {
734 XTENSOR_THROW(std::runtime_error, "Trying to reshape xtensor_fixed with different shape or layout.");
735 }
736 return *this;
737 }
738
739 template <class ET, class S, layout_type L, bool SH, class Tag>
740 template <class ST>
741 inline bool xfixed_container<ET, S, L, SH, Tag>::broadcast_shape(ST& shape, bool) const
742 {
743 return xt::broadcast_shape(m_shape, shape);
744 }
745
746 template <class ET, class S, layout_type L, bool SH, class Tag>
747 constexpr layout_type xfixed_container<ET, S, L, SH, Tag>::layout() const noexcept
748 {
749 return base_type::static_layout;
750 }
751
752 template <class ET, class S, layout_type L, bool SH, class Tag>
753 inline bool xfixed_container<ET, S, L, SH, Tag>::is_contiguous() const noexcept
754 {
755 using str_type = typename inner_strides_type::value_type;
756 return m_strides.empty() || (layout() == layout_type::row_major && m_strides.back() == str_type(1))
757 || (layout() == layout_type::column_major && m_strides.front() == str_type(1));
758 }
759
760 template <class ET, class S, layout_type L, bool SH, class Tag>
761 inline auto xfixed_container<ET, S, L, SH, Tag>::storage_impl() noexcept -> storage_type&
762 {
763 return m_storage;
764 }
765
766 template <class ET, class S, layout_type L, bool SH, class Tag>
767 inline auto xfixed_container<ET, S, L, SH, Tag>::storage_impl() const noexcept -> const storage_type&
768 {
769 return m_storage;
770 }
771
772 template <class ET, class S, layout_type L, bool SH, class Tag>
773 XTENSOR_CONSTEXPR_RETURN auto xfixed_container<ET, S, L, SH, Tag>::shape_impl() const noexcept
774 -> const inner_shape_type&
775 {
776 return m_shape;
777 }
778
779 template <class ET, class S, layout_type L, bool SH, class Tag>
780 XTENSOR_CONSTEXPR_RETURN auto xfixed_container<ET, S, L, SH, Tag>::strides_impl() const noexcept
781 -> const inner_strides_type&
782 {
783 return m_strides;
784 }
785
786 template <class ET, class S, layout_type L, bool SH, class Tag>
787 XTENSOR_CONSTEXPR_RETURN auto xfixed_container<ET, S, L, SH, Tag>::backstrides_impl() const noexcept
788 -> const inner_backstrides_type&
789 {
790 return m_backstrides;
791 }
792
793 /*******************
794 * xfixed_adaptor *
795 *******************/
796
805 template <class EC, class S, layout_type L, bool SH, class Tag>
806 inline xfixed_adaptor<EC, S, L, SH, Tag>::xfixed_adaptor(storage_type&& data)
807 : base_type()
808 , m_storage(std::move(data))
809 {
810 }
811
816 template <class EC, class S, layout_type L, bool SH, class Tag>
817 inline xfixed_adaptor<EC, S, L, SH, Tag>::xfixed_adaptor(const storage_type& data)
818 : base_type()
819 , m_storage(data)
820 {
821 }
822
828 template <class EC, class S, layout_type L, bool SH, class Tag>
829 template <class D>
830 inline xfixed_adaptor<EC, S, L, SH, Tag>::xfixed_adaptor(D&& data)
831 : base_type()
832 , m_storage(std::forward<D>(data))
833 {
834 }
835
837
838 template <class EC, class S, layout_type L, bool SH, class Tag>
839 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::operator=(const xfixed_adaptor& rhs) -> self_type&
840 {
841 base_type::operator=(rhs);
842 m_storage = rhs.m_storage;
843 return *this;
844 }
845
846 template <class EC, class S, layout_type L, bool SH, class Tag>
847 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::operator=(xfixed_adaptor&& rhs) -> self_type&
848 {
849 base_type::operator=(std::move(rhs));
850 m_storage = rhs.m_storage;
851 return *this;
852 }
853
854 template <class EC, class S, layout_type L, bool SH, class Tag>
855 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::operator=(temporary_type&& rhs) -> self_type&
856 {
857 m_storage.resize(rhs.storage().size());
858 std::copy(rhs.storage().cbegin(), rhs.storage().cend(), m_storage.begin());
859 return *this;
860 }
861
869 template <class EC, class S, layout_type L, bool SH, class Tag>
870 template <class E>
871 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::operator=(const xexpression<E>& e) -> self_type&
872 {
873 return semantic_base::operator=(e);
874 }
875
877
882 template <class ET, class S, layout_type L, bool SH, class Tag>
883 template <class ST>
884 inline void xfixed_adaptor<ET, S, L, SH, Tag>::resize(ST&& shape, bool) const
885 {
886 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
887 XTENSOR_ASSERT(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size());
888 }
889
894 template <class ET, class S, layout_type L, bool SH, class Tag>
895 template <class ST>
896 inline void xfixed_adaptor<ET, S, L, SH, Tag>::resize(ST&& shape, layout_type l) const
897 {
898 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
899 (void) (l);
900 XTENSOR_ASSERT(
901 std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size() && L == l
902 );
903 }
904
909 template <class ET, class S, layout_type L, bool SH, class Tag>
910 template <class ST>
911 inline void xfixed_adaptor<ET, S, L, SH, Tag>::resize(ST&& shape, const strides_type& strides) const
912 {
913 (void) (shape); // remove unused parameter warning if XTENSOR_ASSERT undefined
914 (void) (strides);
915 XTENSOR_ASSERT(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size());
916 XTENSOR_ASSERT(
917 std::equal(strides.begin(), strides.end(), m_strides.begin()) && strides.size() == m_strides.size()
918 );
919 }
920
924 template <class ET, class S, layout_type L, bool SH, class Tag>
925 template <class ST>
926 inline const auto& xfixed_adaptor<ET, S, L, SH, Tag>::reshape(ST&& shape, layout_type layout) const
927 {
928 if (!(std::equal(shape.begin(), shape.end(), m_shape.begin()) && shape.size() == m_shape.size()
929 && layout == L))
930 {
931 XTENSOR_THROW(std::runtime_error, "Trying to reshape xtensor_fixed with different shape or layout.");
932 }
933 return *this;
934 }
935
936 template <class ET, class S, layout_type L, bool SH, class Tag>
937 template <class ST>
938 inline bool xfixed_adaptor<ET, S, L, SH, Tag>::broadcast_shape(ST& shape, bool) const
939 {
940 return xt::broadcast_shape(m_shape, shape);
941 }
942
943 template <class EC, class S, layout_type L, bool SH, class Tag>
944 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::storage_impl() noexcept -> storage_type&
945 {
946 return m_storage;
947 }
948
949 template <class EC, class S, layout_type L, bool SH, class Tag>
950 inline auto xfixed_adaptor<EC, S, L, SH, Tag>::storage_impl() const noexcept -> const storage_type&
951 {
952 return m_storage;
953 }
954
955 template <class EC, class S, layout_type L, bool SH, class Tag>
956 constexpr layout_type xfixed_adaptor<EC, S, L, SH, Tag>::layout() const noexcept
957 {
958 return base_type::static_layout;
959 }
960
961 template <class EC, class S, layout_type L, bool SH, class Tag>
962 inline bool xfixed_adaptor<EC, S, L, SH, Tag>::is_contiguous() const noexcept
963 {
964 using str_type = typename inner_strides_type::value_type;
965 return m_strides.empty() || (layout() == layout_type::row_major && m_strides.back() == str_type(1))
966 || (layout() == layout_type::column_major && m_strides.front() == str_type(1));
967 }
968
969 template <class EC, class S, layout_type L, bool SH, class Tag>
970 XTENSOR_CONSTEXPR_RETURN auto xfixed_adaptor<EC, S, L, SH, Tag>::shape_impl() const noexcept
971 -> const inner_shape_type&
972 {
973 return m_shape;
974 }
975
976 template <class EC, class S, layout_type L, bool SH, class Tag>
977 XTENSOR_CONSTEXPR_RETURN auto xfixed_adaptor<EC, S, L, SH, Tag>::strides_impl() const noexcept
978 -> const inner_strides_type&
979 {
980 return m_strides;
981 }
982
983 template <class EC, class S, layout_type L, bool SH, class Tag>
984 XTENSOR_CONSTEXPR_RETURN auto xfixed_adaptor<EC, S, L, SH, Tag>::backstrides_impl() const noexcept
985 -> const inner_backstrides_type&
986 {
987 return m_backstrides;
988 }
989}
990
991#endif
xt::fixed_shape
Fixed shape implementation for compile time defined arrays.
Definition xstorage.hpp:1662
xt::xcontainer_semantic
Implementation of the xsemantic_base interface for dense multidimensional containers.
Definition xsemantic.hpp:178
xt::xcontainer
Base class for dense multidimensional containers.
Definition xcontainer.hpp:73
xt::xcontainer< xfixed_container< ET, S, L, SH, Tag > >::strides
constexpr const inner_strides_type & strides() const noexcept
Returns the strides of the container.
Definition xcontainer.hpp:396
xt::xcontainer< xfixed_container< ET, S, L, SH, Tag > >::shape
constexpr const inner_shape_type & shape() const noexcept
Returns the shape of the container.
Definition xcontainer.hpp:387
xt::xcontainer< xfixed_adaptor< EC, S, L, SH, Tag > >::data
pointer data() noexcept
Returns a pointer to the underlying array serving as element storage.
Definition xcontainer.hpp:582
xt::xfixed_adaptor
Dense multidimensional container adaptor with tensor semantic and fixed dimension.
Definition xfixed.hpp:448
xt::xfixed_adaptor::xfixed_adaptor
xfixed_adaptor(storage_type &&data)
Constructs an xfixed_adaptor of the given stl-like container.
Definition xfixed.hpp:806
xt::xfixed_adaptor::reshape
const auto & reshape(ST &&shape, layout_type layout=L) const
Note that the xfixed_container cannot be reshaped to a shape different from S.
Definition xfixed.hpp:926
xt::xfixed_adaptor::resize
void resize(ST &&shape, bool force=false) const
Note that the xfixed_adaptor cannot be resized.
Definition xfixed.hpp:884
xt::xfixed_container
Dense multidimensional container with tensor semantic and fixed dimension.
Definition xfixed.hpp:298
xt::xfixed_container::resize
void resize(ST &&shape, bool force=false) const
Note that the xfixed_container cannot be resized.
Definition xfixed.hpp:687
xt::xfixed_container::reshape
const auto & reshape(ST &&shape, layout_type layout=L) const
Note that the xfixed_container cannot be reshaped to a shape different from S.
Definition xfixed.hpp:729
xt::strides
auto strides(const E &e, stride_type type=stride_type::normal) noexcept
Get strides of an object.
Definition xstrides.hpp:248
xt
standard mathematical functions for xexpressions
Definition xaccessible.hpp:18
xt::layout_type
layout_type
Definition xlayout.hpp:24
xt::get_init_type
Definition xfixed.hpp:238
xt::xaccumulator_functor
Definition xaccumulator.hpp:43
xt::xcontainer_inner_types
Definition xiterable.hpp:244
xt::xcontainer_iterable_types
Definition xcontainer.hpp:35
xt::xiterable_inner_types
Definition xiterable.hpp:23