DDC 0.10.0
Loading...
Searching...
No Matches
strided_discrete_domain.hpp
1// Copyright (C) The DDC development team, see COPYRIGHT.md file
2//
3// SPDX-License-Identifier: MIT
4
5#pragma once
6
7#include <cstddef>
8#include <iterator>
9#include <tuple>
10#include <type_traits>
11
12#include <Kokkos_Assert.hpp>
13#include <Kokkos_Macros.hpp>
14
15#include "detail/type_seq.hpp"
16
19
20namespace ddc {
21
22template <class DDim>
24
25template <class... DDims>
27
28template <class T>
29struct is_strided_discrete_domain : std::false_type
30{
31};
32
33template <class... Tags>
34struct is_strided_discrete_domain<StridedDiscreteDomain<Tags...>> : std::true_type
35{
36};
37
38template <class T>
40
41
42namespace detail {
43
44template <class... Tags>
45struct ToTypeSeq<StridedDiscreteDomain<Tags...>>
46{
47 using type = TypeSeq<Tags...>;
48};
49
50template <class T, class U>
51struct RebindDomain;
52
53template <class... DDims, class... ODDims>
54struct RebindDomain<StridedDiscreteDomain<DDims...>, detail::TypeSeq<ODDims...>>
55{
56 using type = StridedDiscreteDomain<ODDims...>;
57};
58
59} // namespace detail
60
61template <class... ODDims>
62KOKKOS_FUNCTION DiscreteVector<ODDims...> prod(
63 DiscreteVector<ODDims...> const& lhs,
64 DiscreteVector<ODDims...> const& rhs) noexcept
65{
66 return DiscreteVector<ODDims...>((get<ODDims>(lhs) * get<ODDims>(rhs))...);
67}
68
69template <class... DDims>
71{
72 template <class...>
73 friend class StridedDiscreteDomain;
74
75 static_assert(
76 type_seq_is_unique_v<detail::TypeSeq<DDims...>>,
77 "The dimensions of a StridedDiscreteDomain must be unique");
78
79public:
80 using discrete_element_type = DiscreteElement<DDims...>;
81
82 using discrete_vector_type = DiscreteVector<DDims...>;
83
84private:
85 DiscreteElement<DDims...> m_element_begin;
86
87 DiscreteVector<DDims...> m_extents;
88
89 DiscreteVector<DDims...> m_strides;
90
91public:
92 static KOKKOS_FUNCTION constexpr std::size_t rank()
93 {
94 return sizeof...(DDims);
95 }
96
97 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain() = default;
98
99 /// Construct a StridedDiscreteDomain by copies and merge of domains
100 template <
101 class... DDoms,
102 class = std::enable_if_t<(is_strided_discrete_domain_v<DDoms> && ...)>>
103 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomain(DDoms const&... domains)
104 : m_element_begin(domains.front()...)
105 , m_extents(domains.extents()...)
106 , m_strides(domains.strides()...)
107 {
108 }
109
110 /** Construct a StridedDiscreteDomain starting from element_begin with size points.
111 * @param element_begin the lower bound in each direction
112 * @param extents the number of points in each direction
113 * @param strides the step between two elements
114 */
115 KOKKOS_FUNCTION constexpr StridedDiscreteDomain(
116 discrete_element_type const& element_begin,
117 discrete_vector_type const& extents,
118 discrete_vector_type const& strides)
119 : m_element_begin(element_begin)
120 , m_extents(extents)
121 , m_strides(strides)
122 {
123 }
124
125 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const& x) = default;
126
127 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain&& x) = default;
128
129 KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain() = default;
130
131 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain const& x)
132 = default;
133
134 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain&& x) = default;
135
136 template <class... ODims>
137 KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain<ODims...> const& other) const
138 {
139 if (empty() && other.empty()) {
140 return true;
141 }
142 return m_element_begin == other.m_element_begin && m_extents == other.m_extents
143 && m_strides == other.m_strides;
144 }
145
146#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
147 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
148 template <class... ODims>
149 KOKKOS_FUNCTION constexpr bool operator!=(StridedDiscreteDomain<ODims...> const& other) const
150 {
151 return !(*this == other);
152 }
153#endif
154
155 KOKKOS_FUNCTION constexpr std::size_t size() const
156 {
157 return (1UL * ... * get<DDims>(m_extents));
158 }
159
160 KOKKOS_FUNCTION constexpr discrete_vector_type extents() const noexcept
161 {
162 return m_extents;
163 }
164
165 KOKKOS_FUNCTION constexpr discrete_vector_type strides() const noexcept
166 {
167 return m_strides;
168 }
169
170 template <class QueryDDim>
171 KOKKOS_FUNCTION constexpr DiscreteVector<QueryDDim> extent() const noexcept
172 {
173 return DiscreteVector<QueryDDim>(m_extents);
174 }
175
176 KOKKOS_FUNCTION constexpr discrete_element_type front() const noexcept
177 {
178 return m_element_begin;
179 }
180
181 KOKKOS_FUNCTION constexpr discrete_element_type back() const noexcept
182 {
183 return discrete_element_type(
184 (DiscreteElement<DDims>(m_element_begin)
185 + (get<DDims>(m_extents) - 1) * get<DDims>(m_strides))...);
186 }
187
188 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type n) const
189 {
190 return StridedDiscreteDomain(front(), n, m_strides);
191 }
192
193 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type n) const
194 {
195 return StridedDiscreteDomain(front() + prod(extents() - n, m_strides), n, m_strides);
196 }
197
198 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type n) const
199 {
200 return StridedDiscreteDomain(front() + prod(n, m_strides), extents() - n, m_strides);
201 }
202
203 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type n) const
204 {
205 return StridedDiscreteDomain(front(), extents() - n, m_strides);
206 }
207
208 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(
209 discrete_vector_type n1,
210 discrete_vector_type n2) const
211 {
212 return StridedDiscreteDomain(front() + prod(n1, m_strides), extents() - n1 - n2, m_strides);
213 }
214
215 KOKKOS_FUNCTION constexpr DiscreteElement<DDims...> operator()(
216 DiscreteVector<DDims...> const& dvect) const noexcept
217 {
218 return m_element_begin + prod(dvect, m_strides);
219 }
220
221 template <class... DElems>
222 KOKKOS_FUNCTION bool contains(DElems const&... delems) const noexcept
223 {
224 static_assert(
225 sizeof...(DDims) == (0 + ... + DElems::size()),
226 "Invalid number of dimensions");
227 static_assert((is_discrete_element_v<DElems> && ...), "Expected DiscreteElements");
228 auto const contains_1d = [](DiscreteElementType const i,
229 DiscreteElementType const b,
230 DiscreteVectorElement const n,
231 DiscreteVectorElement const s) {
232 return (i >= b) && (i < (b + (n - 1) * s + 1)) && ((i - b) % s == 0);
233 };
234 DiscreteElement<DDims...> const delem(delems...);
235 for (std::size_t i = 0; i < rank(); ++i) {
236 if (!contains_1d(
237 detail::array(delem)[i],
238 detail::array(m_element_begin)[i],
239 detail::array(m_extents)[i],
240 detail::array(m_strides)[i])) {
241 return false;
242 }
243 }
244 return true;
245 }
246
247 template <class... DElems>
248 KOKKOS_FUNCTION DiscreteVector<DDims...> distance_from_front(
249 DElems const&... delems) const noexcept
250 {
251 static_assert(
252 sizeof...(DDims) == (0 + ... + DElems::size()),
253 "Invalid number of dimensions");
254 static_assert((is_discrete_element_v<DElems> && ...), "Expected DiscreteElements");
255 KOKKOS_ASSERT(contains(delems...))
256 return DiscreteVector<DDims...>(
257 ((DiscreteElement<DDims>(take<DDims>(delems...))
258 - DiscreteElement<DDims>(m_element_begin))
259 / DiscreteVector<DDims>(m_strides))...);
260 }
261
262 KOKKOS_FUNCTION constexpr bool empty() const noexcept
263 {
264 return size() == 0;
265 }
266
267 KOKKOS_FUNCTION constexpr explicit operator bool()
268 {
269 return !empty();
270 }
271
272 template <
273 std::size_t N = sizeof...(DDims),
274 class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
275 KOKKOS_FUNCTION auto begin() const
276 {
277 return StridedDiscreteDomainIterator<DDim0>(front(), m_strides);
278 }
279
280 template <
281 std::size_t N = sizeof...(DDims),
282 class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
283 KOKKOS_FUNCTION auto end() const
284 {
286 DDim0>(m_element_begin + m_extents * m_strides, m_strides);
287 }
288
289 template <
290 std::size_t N = sizeof...(DDims),
291 class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
292 KOKKOS_FUNCTION auto cbegin() const
293 {
294 return StridedDiscreteDomainIterator<DDim0>(front(), m_strides);
295 }
296
297 template <
298 std::size_t N = sizeof...(DDims),
299 class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
300 KOKKOS_FUNCTION auto cend() const
301 {
303 DDim0>(m_element_begin + m_extents * m_strides, m_strides);
304 }
305
306 template <
307 std::size_t N = sizeof...(DDims),
308 class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
309 KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n)
310 {
311 return begin()[n];
312 }
313
314 template <
315 std::size_t N = sizeof...(DDims),
316 class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
317 KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n) const
318 {
319 return begin()[n];
320 }
321};
322
323template <>
325{
326 template <class...>
327 friend class StridedDiscreteDomain;
328
329public:
330 using discrete_element_type = DiscreteElement<>;
331
332 using discrete_vector_type = DiscreteVector<>;
333
334 static KOKKOS_FUNCTION constexpr std::size_t rank()
335 {
336 return 0;
337 }
338
339 KOKKOS_DEFAULTED_FUNCTION constexpr StridedDiscreteDomain() = default;
340
341 // Construct a StridedDiscreteDomain from a reordered copy of `domain`
342 template <class... ODDims>
343 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomain(
344 StridedDiscreteDomain<ODDims...> const& /*domain*/)
345 {
346 }
347
348 /** Construct a StridedDiscreteDomain starting from element_begin with size points.
349 * @param element_begin the lower bound in each direction
350 * @param size the number of points in each direction
351 * @param strides the step between two elements
352 */
353 KOKKOS_FUNCTION constexpr StridedDiscreteDomain(
354 [[maybe_unused]] discrete_element_type const& element_begin,
355 [[maybe_unused]] discrete_vector_type const& size,
356 [[maybe_unused]] discrete_vector_type const& strides)
357 {
358 // Parameters `element_begin`, `size` and `strides` are truly unused
359 }
360
361 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const& x) = default;
362
363 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain&& x) = default;
364
365 KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain() = default;
366
367 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain const& x)
368 = default;
369
370 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain&& x) = default;
371
372 KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain const& /*other*/) const
373 {
374 return true;
375 }
376
377#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
378 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
379 KOKKOS_FUNCTION constexpr bool operator!=(StridedDiscreteDomain const& other) const
380 {
381 return !(*this == other);
382 }
383#endif
384
385 static KOKKOS_FUNCTION constexpr std::size_t size()
386 {
387 return 1;
388 }
389
390 static KOKKOS_FUNCTION constexpr discrete_vector_type extents() noexcept
391 {
392 return {};
393 }
394
395 static KOKKOS_FUNCTION constexpr discrete_element_type front() noexcept
396 {
397 return {};
398 }
399
400 static KOKKOS_FUNCTION constexpr discrete_element_type back() noexcept
401 {
402 return {};
403 }
404
405 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type /*n*/) const
406 {
407 return *this;
408 }
409
410 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type /*n*/) const
411 {
412 return *this;
413 }
414
415 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type /*n*/) const
416 {
417 return *this;
418 }
419
420 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type /*n*/) const
421 {
422 return *this;
423 }
424
425 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(
426 discrete_vector_type /*n1*/,
427 discrete_vector_type /*n2*/) const
428 {
429 return *this;
430 }
431
432 KOKKOS_FUNCTION constexpr DiscreteElement<> operator()(
433 DiscreteVector<> const& /*dvect*/) const noexcept
434 {
435 return {};
436 }
437
438 static KOKKOS_FUNCTION bool contains() noexcept
439 {
440 return true;
441 }
442
443 static KOKKOS_FUNCTION bool contains(DiscreteElement<>) noexcept
444 {
445 return true;
446 }
447
448 static KOKKOS_FUNCTION DiscreteVector<> distance_from_front() noexcept
449 {
450 return {};
451 }
452
453 static KOKKOS_FUNCTION DiscreteVector<> distance_from_front(DiscreteElement<>) noexcept
454 {
455 return {};
456 }
457
458 static KOKKOS_FUNCTION constexpr bool empty() noexcept
459 {
460 return false;
461 }
462
463 KOKKOS_FUNCTION constexpr explicit operator bool()
464 {
465 return true;
466 }
467};
468
469template <class... QueryDDims, class... DDims>
470KOKKOS_FUNCTION constexpr StridedDiscreteDomain<QueryDDims...> select(
471 StridedDiscreteDomain<DDims...> const& domain)
472{
473 return StridedDiscreteDomain<QueryDDims...>(domain);
474}
475
476namespace detail {
477
478template <class T>
479struct ConvertTypeSeqToStridedDiscreteDomain;
480
481template <class... DDims>
482struct ConvertTypeSeqToStridedDiscreteDomain<detail::TypeSeq<DDims...>>
483{
484 using type = StridedDiscreteDomain<DDims...>;
485};
486
487template <class T>
488using convert_type_seq_to_strided_discrete_domain_t =
489 typename ConvertTypeSeqToStridedDiscreteDomain<T>::type;
490
491} // namespace detail
492
493// Computes the subtraction DDom_a - DDom_b in the sense of linear spaces(retained dimensions are those in DDom_a which are not in DDom_b)
494template <class... DDimsA, class... DDimsB>
495KOKKOS_FUNCTION constexpr auto remove_dims_of(
496 StridedDiscreteDomain<DDimsA...> const& DDom_a,
497 StridedDiscreteDomain<DDimsB...> const& /*DDom_b*/) noexcept
498{
499 using TagSeqA = detail::TypeSeq<DDimsA...>;
500 using TagSeqB = detail::TypeSeq<DDimsB...>;
501
502 using type_seq_r = type_seq_remove_t<TagSeqA, TagSeqB>;
503 return detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(DDom_a);
504}
505
506//! Remove the dimensions DDimsB from DDom_a
507//! @param[in] DDom_a The discrete domain on which to remove dimensions
508//! @return The discrete domain without DDimsB dimensions
509template <class... DDimsB, class... DDimsA>
510KOKKOS_FUNCTION constexpr auto remove_dims_of(
511 StridedDiscreteDomain<DDimsA...> const& DDom_a) noexcept
512{
513 using TagSeqA = detail::TypeSeq<DDimsA...>;
514 using TagSeqB = detail::TypeSeq<DDimsB...>;
515
516 using type_seq_r = type_seq_remove_t<TagSeqA, TagSeqB>;
517 return detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(DDom_a);
518}
519
520namespace detail {
521
522// Checks if dimension of DDom_a is DDim1. If not, returns restriction to DDim2 of DDom_b. May not be useful in its own, it helps for replace_dim_of
523template <typename DDim1, typename DDim2, typename DDimA, typename... DDimsB>
524KOKKOS_FUNCTION constexpr std::conditional_t<
525 std::is_same_v<DDimA, DDim1>,
528replace_dim_of_1d(
529 [[maybe_unused]] StridedDiscreteDomain<DDimA> const& DDom_a,
530 [[maybe_unused]] StridedDiscreteDomain<DDimsB...> const& DDom_b) noexcept
531{
532 if constexpr (std::is_same_v<DDimA, DDim1>) {
533 return ddc::StridedDiscreteDomain<DDim2>(DDom_b);
534 } else {
535 return DDom_a;
536 }
537}
538
539} // namespace detail
540
541// Replace in DDom_a the dimension Dim1 by the dimension Dim2 of DDom_b
542template <typename DDim1, typename DDim2, typename... DDimsA, typename... DDimsB>
543KOKKOS_FUNCTION constexpr auto replace_dim_of(
544 StridedDiscreteDomain<DDimsA...> const& DDom_a,
545 [[maybe_unused]] StridedDiscreteDomain<DDimsB...> const& DDom_b) noexcept
546{
547 // TODO : static_asserts
548 using TagSeqA = detail::TypeSeq<DDimsA...>;
549 using TagSeqB = detail::TypeSeq<DDim1>;
550 using TagSeqC = detail::TypeSeq<DDim2>;
551
552 using type_seq_r = ddc::type_seq_replace_t<TagSeqA, TagSeqB, TagSeqC>;
553 return ddc::detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(
554 detail::replace_dim_of_1d<
555 DDim1,
556 DDim2,
557 DDimsA,
558 DDimsB...>(ddc::StridedDiscreteDomain<DDimsA>(DDom_a), DDom_b)...);
559}
560
561template <class... QueryDDims, class... DDims>
562KOKKOS_FUNCTION constexpr DiscreteVector<QueryDDims...> extents(
563 StridedDiscreteDomain<DDims...> const& domain) noexcept
564{
565 return DiscreteVector<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).size()...);
566}
567
568template <class... QueryDDims, class... DDims>
569KOKKOS_FUNCTION constexpr DiscreteElement<QueryDDims...> front(
570 StridedDiscreteDomain<DDims...> const& domain) noexcept
571{
572 return DiscreteElement<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).front()...);
573}
574
575template <class... QueryDDims, class... DDims>
576KOKKOS_FUNCTION constexpr DiscreteElement<QueryDDims...> back(
577 StridedDiscreteDomain<DDims...> const& domain) noexcept
578{
579 return DiscreteElement<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).back()...);
580}
581
582template <class DDim>
584{
585private:
586 DiscreteElement<DDim> m_value = DiscreteElement<DDim>();
587
588 DiscreteVector<DDim> m_stride = DiscreteVector<DDim>();
589
590public:
591 using iterator_category = std::random_access_iterator_tag;
592
593 using value_type = DiscreteElement<DDim>;
594
595 using difference_type = std::ptrdiff_t;
596
597 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomainIterator() = default;
598
599 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomainIterator(
600 DiscreteElement<DDim> value,
601 DiscreteVector<DDim> stride)
602 : m_value(value)
603 , m_stride(stride)
604 {
605 }
606
607 KOKKOS_FUNCTION constexpr DiscreteElement<DDim> operator*() const noexcept
608 {
609 return m_value;
610 }
611
612 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator++()
613 {
614 m_value += m_stride;
615 return *this;
616 }
617
618 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator++(int)
619 {
620 auto tmp = *this;
621 ++*this;
622 return tmp;
623 }
624
625 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator--()
626 {
627 m_value -= m_stride;
628 return *this;
629 }
630
631 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator--(int)
632 {
633 auto tmp = *this;
634 --*this;
635 return tmp;
636 }
637
638 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator+=(difference_type n)
639 {
640 if (n >= static_cast<difference_type>(0)) {
641 m_value += static_cast<DiscreteElementType>(n) * m_stride;
642 } else {
643 m_value -= static_cast<DiscreteElementType>(-n) * m_stride;
644 }
645 return *this;
646 }
647
648 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator-=(difference_type n)
649 {
650 if (n >= static_cast<difference_type>(0)) {
651 m_value -= static_cast<DiscreteElementType>(n) * m_stride;
652 } else {
653 m_value += static_cast<DiscreteElementType>(-n) * m_stride;
654 }
655 return *this;
656 }
657
658 KOKKOS_FUNCTION constexpr DiscreteElement<DDim> operator[](difference_type n) const
659 {
660 return m_value + n * m_stride;
661 }
662
663 friend KOKKOS_FUNCTION constexpr bool operator==(
666 {
667 return xx.m_value == yy.m_value;
668 }
669
670#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
671 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
672 friend KOKKOS_FUNCTION constexpr bool operator!=(
675 {
676 return xx.m_value != yy.m_value;
677 }
678#endif
679
680 friend KOKKOS_FUNCTION constexpr bool operator<(
683 {
684 return xx.m_value < yy.m_value;
685 }
686
687 friend KOKKOS_FUNCTION constexpr bool operator>(
690 {
691 return yy < xx;
692 }
693
694 friend KOKKOS_FUNCTION constexpr bool operator<=(
697 {
698 return !(yy < xx);
699 }
700
701 friend KOKKOS_FUNCTION constexpr bool operator>=(
704 {
705 return !(xx < yy);
706 }
707
708 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(
710 difference_type n)
711 {
712 return i += n;
713 }
714
715 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(
716 difference_type n,
718 {
719 return i += n;
720 }
721
722 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator-(
724 difference_type n)
725 {
726 return i -= n;
727 }
728
729 friend KOKKOS_FUNCTION constexpr difference_type operator-(
732 {
733 return (yy.m_value > xx.m_value) ? (-static_cast<difference_type>(yy.m_value - xx.m_value))
734 : (xx.m_value - yy.m_value);
735 }
736};
737
738} // namespace ddc
friend class DiscreteDomain
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteElement()=default
KOKKOS_FUNCTION constexpr bool operator!=(DiscreteVector< OTags... > const &rhs) const noexcept
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector()=default
KOKKOS_FUNCTION std::size_t size() const
KOKKOS_FUNCTION Coordinate< CDim > coordinate(discrete_element_type const &icoord) const noexcept
Convert a mesh index into a position in CDim
Impl(Impl< DDim, OriginMemorySpace > const &impl)
Impl & operator=(Impl &&x)=default
Impl & operator=(Impl const &x)=delete
Impl(InputIt const points_begin, InputIt const points_end)
Construct a NonUniformPointSampling using a pair of iterators.
KOKKOS_FUNCTION discrete_element_type front() const noexcept
Lower bound index of the mesh.
Impl(InputRange const &points)
Construct a NonUniformPointSampling using a C++20 "common range".
Impl(std::initializer_list< Coordinate< CDim > > const points)
Construct a NonUniformPointSampling using a brace-list, i.e. NonUniformPointSampling mesh({0....
NonUniformPointSampling models a non-uniform discretization of the CDim segment .
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim > > init(InputRange const &non_uniform_points)
Construct an Impl<Kokkos::HostSpace> and associated discrete_domain_type from a range containing the ...
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > init_ghosted(InputRange const &domain_r, InputRange const &pre_ghost_r, InputRange const &post_ghost_r)
Construct 4 non-uniform DiscreteDomain and an Impl<Kokkos::HostSpace> from 3 ranges containing the po...
Impl & operator=(Impl &&x)=default
KOKKOS_FUNCTION Coordinate< CDim > origin() const noexcept
Lower bound index of the mesh.
KOKKOS_FUNCTION discrete_element_type front() const noexcept
Lower bound index of the mesh.
KOKKOS_FUNCTION Coordinate< CDim > coordinate(discrete_element_type const &icoord) const noexcept
Convert a mesh index into a position in CDim
Impl(Impl const &)=delete
KOKKOS_FUNCTION std::size_t n_period() const
Number of steps in a period.
Impl(Impl< DDim, OriginMemorySpace > const &impl)
Impl(Coordinate< CDim > origin, Real step, std::size_t n_period)
Construct a Impl from a point and a spacing step.
KOKKOS_FUNCTION Real step() const
Spacing step of the mesh.
Impl & operator=(Impl const &x)=delete
PeriodicSampling models a periodic discretization of the provided continuous dimension.
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim > > init(Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_period)
Construct a Impl<Kokkos::HostSpace> and associated discrete_domain_type from a segment and a number ...
std::tuple< Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > init_ghosted(Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_period, DiscreteVector< DDim > n_ghosts_before, DiscreteVector< DDim > n_ghosts_after)
Construct a periodic DiscreteDomain from a segment and a number of points n.
std::tuple< Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > init_ghosted(Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_period, DiscreteVector< DDim > n_ghosts)
Construct a periodic DiscreteDomain from a segment and a number of points n.
ScopeGuard & operator=(ScopeGuard const &x)=delete
~ScopeGuard() noexcept
ScopeGuard(ScopeGuard &&x) noexcept=delete
ScopeGuard & operator=(ScopeGuard &&x) noexcept=delete
ScopeGuard(int, char **&)
ScopeGuard(ScopeGuard const &x)=delete
static KOKKOS_FUNCTION bool contains(DiscreteElement<>) noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove(discrete_vector_type, discrete_vector_type) const
KOKKOS_FUNCTION constexpr SparseDiscreteDomain take_first(discrete_vector_type) const
static KOKKOS_FUNCTION constexpr std::size_t rank()
KOKKOS_DEFAULTED_FUNCTION constexpr SparseDiscreteDomain()=default
KOKKOS_FUNCTION constexpr DiscreteElement operator()(DiscreteVector<> const &) const noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove_last(discrete_vector_type) const
static KOKKOS_FUNCTION DiscreteVector distance_from_front() noexcept
static KOKKOS_FUNCTION constexpr std::size_t size()
static KOKKOS_FUNCTION constexpr bool empty() noexcept
static KOKKOS_FUNCTION DiscreteVector distance_from_front(DiscreteElement<>) noexcept
KOKKOS_FUNCTION constexpr bool operator==(SparseDiscreteDomain const &) const
static KOKKOS_FUNCTION constexpr discrete_element_type back() noexcept
static KOKKOS_FUNCTION bool contains() noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain take_last(discrete_vector_type) const
KOKKOS_FUNCTION constexpr operator bool()
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain & operator=(SparseDiscreteDomain const &x)=default
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain & operator=(SparseDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove_first(discrete_vector_type) const
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain(SparseDiscreteDomain const &x)=default
KOKKOS_DEFAULTED_FUNCTION ~SparseDiscreteDomain()=default
static KOKKOS_FUNCTION constexpr discrete_element_type front() noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain(SparseDiscreteDomain< ODDims... > const &)
static KOKKOS_FUNCTION constexpr discrete_vector_type extents() noexcept
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain(SparseDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr discrete_element_type back() const noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove_first(discrete_vector_type n) const
static KOKKOS_FUNCTION constexpr std::size_t rank()
KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n) const
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain & operator=(SparseDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr SparseDiscreteDomain take_last(discrete_vector_type n) const
KOKKOS_FUNCTION DiscreteVector< DDims... > distance_from_front(DElems const &... delems) const noexcept
KOKKOS_FUNCTION constexpr auto discrete_elements() const noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove(discrete_vector_type n1, discrete_vector_type n2) const
KOKKOS_FUNCTION constexpr SparseDiscreteDomain(DDoms const &... domains)
Construct a SparseDiscreteDomain by copies and merge of domains.
SparseDiscreteDomain(Kokkos::View< DiscreteElement< DDims > *, Kokkos::SharedSpace > const &... views)
Construct a SparseDiscreteDomain with Kokkos::View explicitly listing the discrete elements.
KOKKOS_FUNCTION auto cbegin() const
KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n)
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain & operator=(SparseDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr std::size_t size() const
KOKKOS_FUNCTION constexpr bool operator==(SparseDiscreteDomain< ODims... > const &other) const
KOKKOS_FUNCTION bool contains(DElems const &... delems) const noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain take_first(discrete_vector_type n) const
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain()=default
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain(SparseDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr discrete_element_type front() const noexcept
KOKKOS_FUNCTION constexpr operator bool()
KOKKOS_FUNCTION constexpr bool empty() const noexcept
KOKKOS_FUNCTION constexpr DiscreteElement< DDims... > operator()(DiscreteVector< DDims... > const &dvect) const noexcept
KOKKOS_DEFAULTED_FUNCTION SparseDiscreteDomain(SparseDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr SparseDiscreteDomain remove_last(discrete_vector_type n) const
KOKKOS_FUNCTION auto end() const
KOKKOS_FUNCTION auto cend() const
KOKKOS_FUNCTION auto begin() const
KOKKOS_FUNCTION constexpr discrete_vector_type extents() const noexcept
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDim > extent() const noexcept
KOKKOS_DEFAULTED_FUNCTION ~SparseDiscreteDomain()=default
static KOKKOS_FUNCTION DiscreteVector distance_from_front() noexcept
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & operator=(StridedDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type) const
static KOKKOS_FUNCTION constexpr std::size_t size()
KOKKOS_FUNCTION constexpr StridedDiscreteDomain(discrete_element_type const &element_begin, discrete_vector_type const &size, discrete_vector_type const &strides)
Construct a StridedDiscreteDomain starting from element_begin with size points.
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(discrete_vector_type, discrete_vector_type) const
static KOKKOS_FUNCTION bool contains(DiscreteElement<>) noexcept
static KOKKOS_FUNCTION constexpr discrete_element_type front() noexcept
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type) const
KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain const &) const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type) const
static KOKKOS_FUNCTION bool contains() noexcept
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type) const
static KOKKOS_FUNCTION constexpr discrete_vector_type extents() noexcept
static KOKKOS_FUNCTION constexpr std::size_t rank()
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain &&x)=default
static KOKKOS_FUNCTION DiscreteVector distance_from_front(DiscreteElement<>) noexcept
KOKKOS_DEFAULTED_FUNCTION constexpr StridedDiscreteDomain()=default
KOKKOS_FUNCTION constexpr operator bool()
static KOKKOS_FUNCTION constexpr bool empty() noexcept
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr DiscreteElement operator()(DiscreteVector<> const &) const noexcept
static KOKKOS_FUNCTION constexpr discrete_element_type back() noexcept
KOKKOS_FUNCTION constexpr StridedDiscreteDomain(StridedDiscreteDomain< ODDims... > const &)
KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain()=default
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & operator=(StridedDiscreteDomain const &x)=default
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & operator=(StridedDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr discrete_vector_type extents() const noexcept
KOKKOS_FUNCTION constexpr operator bool()
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type n) const
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDim > extent() const noexcept
KOKKOS_FUNCTION constexpr discrete_element_type front() const noexcept
KOKKOS_FUNCTION bool contains(DElems const &... delems) const noexcept
KOKKOS_FUNCTION constexpr std::size_t size() const
KOKKOS_FUNCTION auto cend() const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain(DDoms const &... domains)
Construct a StridedDiscreteDomain by copies and merge of domains.
KOKKOS_FUNCTION DiscreteVector< DDims... > distance_from_front(DElems const &... delems) const noexcept
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr discrete_vector_type strides() const noexcept
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & operator=(StridedDiscreteDomain &&x)=default
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(discrete_vector_type n1, discrete_vector_type n2) const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type n) const
KOKKOS_FUNCTION constexpr discrete_element_type back() const noexcept
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain()=default
KOKKOS_FUNCTION constexpr DiscreteElement< DDims... > operator()(DiscreteVector< DDims... > const &dvect) const noexcept
KOKKOS_FUNCTION auto begin() const
KOKKOS_FUNCTION auto end() const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type n) const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type n) const
KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain()=default
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain< ODims... > const &other) const
KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n)
static KOKKOS_FUNCTION constexpr std::size_t rank()
KOKKOS_FUNCTION auto cbegin() const
KOKKOS_FUNCTION constexpr bool empty() const noexcept
KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n) const
KOKKOS_FUNCTION constexpr StridedDiscreteDomain(discrete_element_type const &element_begin, discrete_vector_type const &extents, discrete_vector_type const &strides)
Construct a StridedDiscreteDomain starting from element_begin with size points.
The top-level namespace of DDC.
KOKKOS_FUNCTION std::enable_if_t< is_periodic_sampling_v< DDim >, Real > step() noexcept
Spacing step of the mesh.
KOKKOS_FUNCTION std::enable_if_t< is_periodic_sampling_v< DDim >, Coordinate< typename DDim::continuous_dimension_type > > origin() noexcept
Lower bound index of the mesh.
constexpr bool is_non_uniform_point_sampling_v
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rmax(DiscreteDomain< DDim > const &d)
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > back(SparseDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > front(StridedDiscreteDomain< DDims... > const &domain) noexcept
bool is_discrete_space_initialized() noexcept
KOKKOS_FUNCTION constexpr SparseDiscreteDomain< QueryDDims... > select(SparseDiscreteDomain< DDims... > const &domain)
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDims... > extents(StridedDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > back(StridedDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION constexpr StridedDiscreteDomain< QueryDDims... > select(StridedDiscreteDomain< DDims... > const &domain)
KOKKOS_FUNCTION constexpr auto remove_dims_of(StridedDiscreteDomain< DDimsA... > const &DDom_a) noexcept
Remove the dimensions DDimsB from DDom_a.
void init_discrete_space(Args &&... args)
Initialize (emplace) a global singleton discrete space.
KOKKOS_FUNCTION constexpr auto remove_dims_of(StridedDiscreteDomain< DDimsA... > const &DDom_a, StridedDiscreteDomain< DDimsB... > const &) noexcept
KOKKOS_FUNCTION constexpr auto remove_dims_of(SparseDiscreteDomain< DDimsA... > const &DDom_a, SparseDiscreteDomain< DDimsB... > const &) noexcept
detail::ddim_impl_t< DDim, Kokkos::HostSpace > const & host_discrete_space()
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDims... > extents(SparseDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION constexpr auto replace_dim_of(SparseDiscreteDomain< DDimsA... > const &DDom_a, SparseDiscreteDomain< DDimsB... > const &DDom_b) noexcept
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > front(SparseDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rlength(DiscreteDomain< DDim > const &d)
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > distance_at_left(DiscreteElement< DDim > i)
constexpr bool is_strided_discrete_domain_v
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rmin(DiscreteDomain< DDim > const &d)
KOKKOS_FUNCTION DiscreteVector< ODDims... > prod(DiscreteVector< ODDims... > const &lhs, DiscreteVector< ODDims... > const &rhs) noexcept
constexpr bool is_periodic_sampling_v
KOKKOS_FUNCTION constexpr auto replace_dim_of(StridedDiscreteDomain< DDimsA... > const &DDom_a, StridedDiscreteDomain< DDimsB... > const &DDom_b) noexcept
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > coordinate(DiscreteElement< DDim > const &c)
KOKKOS_FUNCTION std::enable_if_t< is_periodic_sampling_v< DDim >, DiscreteElement< DDim > > front() noexcept
Lower bound index of the mesh.
constexpr bool is_sparse_discrete_domain_v
KOKKOS_FUNCTION constexpr auto remove_dims_of(SparseDiscreteDomain< DDimsA... > const &DDom_a) noexcept
Remove the dimensions DDimsB from DDom_a.
KOKKOS_FUNCTION detail::ddim_impl_t< DDim, MemorySpace > const & discrete_space()
Arg0 init_discrete_space(std::tuple< DDimImpl, Arg0 > &&a)
Move construct a global singleton discrete space and pass through the other argument.
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > distance_at_right(DiscreteElement< DDim > i)
std::tuple< Arg0, Arg1, Args... > init_discrete_space(std::tuple< DDimImpl, Arg0, Arg1, Args... > &&a)
Move construct a global singleton discrete space and pass through remaining arguments.
friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator-(StridedDiscreteDomainIterator i, difference_type n)
KOKKOS_FUNCTION constexpr DiscreteElement< DDim > operator*() const noexcept
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator & operator++()
friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(difference_type n, StridedDiscreteDomainIterator i)
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator & operator-=(difference_type n)
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator++(int)
friend KOKKOS_FUNCTION constexpr bool operator<(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomainIterator()=default
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator--(int)
friend KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator(DiscreteElement< DDim > value, DiscreteVector< DDim > stride)
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator & operator+=(difference_type n)
KOKKOS_FUNCTION constexpr DiscreteElement< DDim > operator[](difference_type n) const
friend KOKKOS_FUNCTION constexpr difference_type operator-(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator & operator--()
friend KOKKOS_FUNCTION constexpr bool operator>=(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(StridedDiscreteDomainIterator i, difference_type n)
friend KOKKOS_FUNCTION constexpr bool operator>(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
friend KOKKOS_FUNCTION constexpr bool operator!=(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)
friend KOKKOS_FUNCTION constexpr bool operator<=(StridedDiscreteDomainIterator const &xx, StridedDiscreteDomainIterator const &yy)