DDC 0.14.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
41namespace concepts {
42
43template <class T>
44concept strided_discrete_domain = is_strided_discrete_domain_v<T>;
45
46}
47
48namespace detail {
49
50template <class... Tags>
51struct ToTypeSeq<StridedDiscreteDomain<Tags...>>
52{
53 using type = TypeSeq<Tags...>;
54};
55
56template <class... DDims, class... ODDims>
57struct Rebind<StridedDiscreteDomain<DDims...>, detail::TypeSeq<ODDims...>>
58{
59 using type = StridedDiscreteDomain<ODDims...>;
60};
61
62} // namespace detail
63
64template <class... ODDims>
65KOKKOS_FUNCTION DiscreteVector<ODDims...> prod(
66 DiscreteVector<ODDims...> const& lhs,
67 DiscreteVector<ODDims...> const& rhs) noexcept
68{
69 return DiscreteVector<ODDims...>((get<ODDims>(lhs) * get<ODDims>(rhs))...);
70}
71
72template <class... DDims>
74{
75 template <class...>
76 friend class StridedDiscreteDomain;
77
78 static_assert(
79 type_seq_is_unique_v<detail::TypeSeq<DDims...>>,
80 "The dimensions of a StridedDiscreteDomain must be unique");
81
82public:
83 using discrete_element_type = DiscreteElement<DDims...>;
84
85 using discrete_vector_type = DiscreteVector<DDims...>;
86
87private:
88 DiscreteElement<DDims...> m_element_begin;
89
90 DiscreteVector<DDims...> m_extents;
91
92 DiscreteVector<DDims...> m_strides;
93
94public:
95 static KOKKOS_FUNCTION constexpr std::size_t rank()
96 {
97 return sizeof...(DDims);
98 }
99
100 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain() = default;
101
102 /// Construct a StridedDiscreteDomain by copies and merge of domains
103 template <concepts::strided_discrete_domain... DDoms>
104 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomain(DDoms const&... domains)
105 : m_element_begin(domains.front()...)
106 , m_extents(domains.extents()...)
107 , m_strides(domains.strides()...)
108 {
109 }
110
111 /** Construct a StridedDiscreteDomain starting from element_begin with size points.
112 * @param element_begin the lower bound in each direction
113 * @param extents the number of points in each direction
114 * @param strides the step between two elements
115 */
116 KOKKOS_FUNCTION constexpr StridedDiscreteDomain(
117 discrete_element_type const& element_begin,
118 discrete_vector_type const& extents,
119 discrete_vector_type const& strides)
120 : m_element_begin(element_begin)
121 , m_extents(extents)
122 , m_strides(strides)
123 {
124 }
125
126 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const& x) = default;
127
128 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain&& x) = default;
129
130 KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain() = default;
131
132 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain const& x)
133 = default;
134
135 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain&& x) = default;
136
137 template <class... ODims>
138 KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain<ODims...> const& other) const
139 {
140 if (empty() && other.empty()) {
141 return true;
142 }
143 return m_element_begin == other.m_element_begin && m_extents == other.m_extents
144 && m_strides == other.m_strides;
145 }
146
147#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
148 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
149 template <class... ODims>
150 KOKKOS_FUNCTION constexpr bool operator!=(StridedDiscreteDomain<ODims...> const& other) const
151 {
152 return !(*this == other);
153 }
154#endif
155
156 KOKKOS_FUNCTION constexpr std::size_t size() const
157 {
158 return (1UL * ... * get<DDims>(m_extents));
159 }
160
161 KOKKOS_FUNCTION constexpr discrete_vector_type extents() const noexcept
162 {
163 return m_extents;
164 }
165
166 KOKKOS_FUNCTION constexpr discrete_vector_type strides() const noexcept
167 {
168 return m_strides;
169 }
170
171 template <class QueryDDim>
172 KOKKOS_FUNCTION constexpr DiscreteVector<QueryDDim> extent() const noexcept
173 {
174 return DiscreteVector<QueryDDim>(m_extents);
175 }
176
177 KOKKOS_FUNCTION constexpr discrete_element_type front() const noexcept
178 {
179 return m_element_begin;
180 }
181
182 KOKKOS_FUNCTION constexpr discrete_element_type back() const noexcept
183 {
184 return discrete_element_type(
185 (DiscreteElement<DDims>(m_element_begin)
186 + (get<DDims>(m_extents) - 1) * get<DDims>(m_strides))...);
187 }
188
189 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type n) const
190 {
191 return StridedDiscreteDomain(front(), n, m_strides);
192 }
193
194 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type n) const
195 {
196 return StridedDiscreteDomain(front() + prod(extents() - n, m_strides), n, m_strides);
197 }
198
199 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type n) const
200 {
201 return StridedDiscreteDomain(front() + prod(n, m_strides), extents() - n, m_strides);
202 }
203
204 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type n) const
205 {
206 return StridedDiscreteDomain(front(), extents() - n, m_strides);
207 }
208
209 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(
210 discrete_vector_type n1,
211 discrete_vector_type n2) const
212 {
213 return StridedDiscreteDomain(front() + prod(n1, m_strides), extents() - n1 - n2, m_strides);
214 }
215
216 KOKKOS_FUNCTION constexpr DiscreteElement<DDims...> operator()(
217 DiscreteVector<DDims...> const& dvect) const noexcept
218 {
219 return m_element_begin + prod(dvect, m_strides);
220 }
221
222 template <class... DElems>
223 KOKKOS_FUNCTION bool contains(DElems const&... delems) const noexcept
224 {
225 static_assert(
226 sizeof...(DDims) == (0 + ... + DElems::size()),
227 "Invalid number of dimensions");
228 static_assert((is_discrete_element_v<DElems> && ...), "Expected DiscreteElements");
229 auto const contains_1d = [](DiscreteElementType const i,
230 DiscreteElementType const b,
231 DiscreteVectorElement const n,
232 DiscreteVectorElement const s) {
233 return (i >= b) && (i < (b + (n - 1) * s + 1)) && ((i - b) % s == 0);
234 };
235 DiscreteElement<DDims...> const delem(delems...);
236 for (std::size_t i = 0; i < rank(); ++i) {
237 if (!contains_1d(
238 detail::array(delem)[i],
239 detail::array(m_element_begin)[i],
240 detail::array(m_extents)[i],
241 detail::array(m_strides)[i])) {
242 return false;
243 }
244 }
245 return true;
246 }
247
248 template <class... DElems>
249 KOKKOS_FUNCTION DiscreteVector<DDims...> distance_from_front(
250 DElems const&... delems) const noexcept
251 {
252 static_assert(
253 sizeof...(DDims) == (0 + ... + DElems::size()),
254 "Invalid number of dimensions");
255 static_assert((is_discrete_element_v<DElems> && ...), "Expected DiscreteElements");
256 KOKKOS_ASSERT(contains(delems...))
257 return DiscreteVector<DDims...>(
258 ((DiscreteElement<DDims>(take<DDims>(delems...))
259 - DiscreteElement<DDims>(m_element_begin))
260 / DiscreteVector<DDims>(m_strides))...);
261 }
262
263 KOKKOS_FUNCTION constexpr bool empty() const noexcept
264 {
265 return size() == 0;
266 }
267
268 KOKKOS_FUNCTION constexpr explicit operator bool()
269 {
270 return !empty();
271 }
272
273 KOKKOS_FUNCTION auto begin() const
274 requires(sizeof...(DDims) == 1)
275 {
277 std::tuple_element_t<0, std::tuple<DDims...>>>(front(), m_strides);
278 }
279
280 KOKKOS_FUNCTION auto end() const
281 requires(sizeof...(DDims) == 1)
282 {
283 return StridedDiscreteDomainIterator<std::tuple_element_t<
284 0,
285 std::tuple<DDims...>>>(m_element_begin + m_extents * m_strides, m_strides);
286 }
287
288 KOKKOS_FUNCTION auto cbegin() const
289 requires(sizeof...(DDims) == 1)
290 {
292 std::tuple_element_t<0, std::tuple<DDims...>>>(front(), m_strides);
293 }
294
295 KOKKOS_FUNCTION auto cend() const
296 requires(sizeof...(DDims) == 1)
297 {
298 return StridedDiscreteDomainIterator<std::tuple_element_t<
299 0,
300 std::tuple<DDims...>>>(m_element_begin + m_extents * m_strides, m_strides);
301 }
302
303 KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n)
304 requires(sizeof...(DDims) == 1)
305 {
306 return begin()[n];
307 }
308
309 KOKKOS_FUNCTION constexpr decltype(auto) operator[](std::size_t n) const
310 requires(sizeof...(DDims) == 1)
311 {
312 return begin()[n];
313 }
314};
315
316template <>
318{
319 template <class...>
320 friend class StridedDiscreteDomain;
321
322public:
323 using discrete_element_type = DiscreteElement<>;
324
325 using discrete_vector_type = DiscreteVector<>;
326
327 static KOKKOS_FUNCTION constexpr std::size_t rank()
328 {
329 return 0;
330 }
331
332 KOKKOS_DEFAULTED_FUNCTION constexpr StridedDiscreteDomain() = default;
333
334 // Construct a StridedDiscreteDomain from a reordered copy of `domain`
335 template <class... ODDims>
336 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomain(
337 StridedDiscreteDomain<ODDims...> const& /*domain*/)
338 {
339 }
340
341 /** Construct a StridedDiscreteDomain starting from element_begin with size points.
342 * @param element_begin the lower bound in each direction
343 * @param size the number of points in each direction
344 * @param strides the step between two elements
345 */
346 KOKKOS_FUNCTION constexpr StridedDiscreteDomain(
347 [[maybe_unused]] discrete_element_type const& element_begin,
348 [[maybe_unused]] discrete_vector_type const& size,
349 [[maybe_unused]] discrete_vector_type const& strides)
350 {
351 // Parameters `element_begin`, `size` and `strides` are truly unused
352 }
353
354 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const& x) = default;
355
356 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain&& x) = default;
357
358 KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain() = default;
359
360 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain const& x)
361 = default;
362
363 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain& operator=(StridedDiscreteDomain&& x) = default;
364
365 KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain const& /*other*/) const
366 {
367 return true;
368 }
369
370#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
371 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
372 KOKKOS_FUNCTION constexpr bool operator!=(StridedDiscreteDomain const& other) const
373 {
374 return !(*this == other);
375 }
376#endif
377
378 static KOKKOS_FUNCTION constexpr std::size_t size()
379 {
380 return 1;
381 }
382
383 static KOKKOS_FUNCTION constexpr discrete_vector_type extents() noexcept
384 {
385 return {};
386 }
387
388 static KOKKOS_FUNCTION constexpr discrete_element_type front() noexcept
389 {
390 return {};
391 }
392
393 static KOKKOS_FUNCTION constexpr discrete_element_type back() noexcept
394 {
395 return {};
396 }
397
398 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first(discrete_vector_type /*n*/) const
399 {
400 return *this;
401 }
402
403 KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last(discrete_vector_type /*n*/) const
404 {
405 return *this;
406 }
407
408 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first(discrete_vector_type /*n*/) const
409 {
410 return *this;
411 }
412
413 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last(discrete_vector_type /*n*/) const
414 {
415 return *this;
416 }
417
418 KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove(
419 discrete_vector_type /*n1*/,
420 discrete_vector_type /*n2*/) const
421 {
422 return *this;
423 }
424
425 KOKKOS_FUNCTION constexpr DiscreteElement<> operator()(
426 DiscreteVector<> const& /*dvect*/) const noexcept
427 {
428 return {};
429 }
430
431 static KOKKOS_FUNCTION bool contains() noexcept
432 {
433 return true;
434 }
435
436 static KOKKOS_FUNCTION bool contains(DiscreteElement<>) noexcept
437 {
438 return true;
439 }
440
441 static KOKKOS_FUNCTION DiscreteVector<> distance_from_front() noexcept
442 {
443 return {};
444 }
445
446 static KOKKOS_FUNCTION DiscreteVector<> distance_from_front(DiscreteElement<>) noexcept
447 {
448 return {};
449 }
450
451 static KOKKOS_FUNCTION constexpr bool empty() noexcept
452 {
453 return false;
454 }
455
456 KOKKOS_FUNCTION constexpr explicit operator bool()
457 {
458 return true;
459 }
460};
461
462template <class... QueryDDims, class... DDims>
463KOKKOS_FUNCTION constexpr StridedDiscreteDomain<QueryDDims...> select(
464 StridedDiscreteDomain<DDims...> const& domain)
465{
466 return StridedDiscreteDomain<QueryDDims...>(domain);
467}
468
469namespace detail {
470
471template <class T>
472struct ConvertTypeSeqToStridedDiscreteDomain
473{
474};
475
476template <class... DDims>
477struct ConvertTypeSeqToStridedDiscreteDomain<detail::TypeSeq<DDims...>>
478{
479 using type = StridedDiscreteDomain<DDims...>;
480};
481
482template <class T>
483using convert_type_seq_to_strided_discrete_domain_t
484 = ConvertTypeSeqToStridedDiscreteDomain<T>::type;
485
486} // namespace detail
487
488// 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)
489template <class... DDimsA, class... DDimsB>
490KOKKOS_FUNCTION constexpr auto remove_dims_of(
491 StridedDiscreteDomain<DDimsA...> const& DDom_a,
492 StridedDiscreteDomain<DDimsB...> const& /*DDom_b*/) noexcept
493{
494 using TagSeqA = detail::TypeSeq<DDimsA...>;
495 using TagSeqB = detail::TypeSeq<DDimsB...>;
496
497 using type_seq_r = type_seq_remove_t<TagSeqA, TagSeqB>;
498 return detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(DDom_a);
499}
500
501//! Remove the dimensions DDimsB from DDom_a
502//! @param[in] DDom_a The discrete domain on which to remove dimensions
503//! @return The discrete domain without DDimsB dimensions
504template <class... DDimsB, class... DDimsA>
505KOKKOS_FUNCTION constexpr auto remove_dims_of(
506 StridedDiscreteDomain<DDimsA...> const& DDom_a) noexcept
507{
508 using TagSeqA = detail::TypeSeq<DDimsA...>;
509 using TagSeqB = detail::TypeSeq<DDimsB...>;
510
511 using type_seq_r = type_seq_remove_t<TagSeqA, TagSeqB>;
512 return detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(DDom_a);
513}
514
515namespace detail {
516
517// 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
518template <typename DDim1, typename DDim2, typename DDimA, typename... DDimsB>
519KOKKOS_FUNCTION constexpr std::conditional_t<
520 std::is_same_v<DDimA, DDim1>,
523replace_dim_of_1d(
524 [[maybe_unused]] StridedDiscreteDomain<DDimA> const& DDom_a,
525 [[maybe_unused]] StridedDiscreteDomain<DDimsB...> const& DDom_b) noexcept
526{
527 if constexpr (std::is_same_v<DDimA, DDim1>) {
528 return ddc::StridedDiscreteDomain<DDim2>(DDom_b);
529 } else {
530 return DDom_a;
531 }
532}
533
534} // namespace detail
535
536// Replace in DDom_a the dimension Dim1 by the dimension Dim2 of DDom_b
537template <typename DDim1, typename DDim2, typename... DDimsA, typename... DDimsB>
538KOKKOS_FUNCTION constexpr auto replace_dim_of(
539 StridedDiscreteDomain<DDimsA...> const& DDom_a,
540 [[maybe_unused]] StridedDiscreteDomain<DDimsB...> const& DDom_b) noexcept
541{
542 // TODO : static_asserts
543 using TagSeqA = detail::TypeSeq<DDimsA...>;
544 using TagSeqB = detail::TypeSeq<DDim1>;
545 using TagSeqC = detail::TypeSeq<DDim2>;
546
547 using type_seq_r = ddc::type_seq_replace_t<TagSeqA, TagSeqB, TagSeqC>;
548 return ddc::detail::convert_type_seq_to_strided_discrete_domain_t<type_seq_r>(
549 detail::replace_dim_of_1d<
550 DDim1,
551 DDim2,
552 DDimsA,
553 DDimsB...>(ddc::StridedDiscreteDomain<DDimsA>(DDom_a), DDom_b)...);
554}
555
556template <class... QueryDDims, class... DDims>
557KOKKOS_FUNCTION constexpr DiscreteVector<QueryDDims...> extents(
558 StridedDiscreteDomain<DDims...> const& domain) noexcept
559{
560 return DiscreteVector<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).size()...);
561}
562
563template <class... QueryDDims, class... DDims>
564KOKKOS_FUNCTION constexpr DiscreteElement<QueryDDims...> front(
565 StridedDiscreteDomain<DDims...> const& domain) noexcept
566{
567 return DiscreteElement<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).front()...);
568}
569
570template <class... QueryDDims, class... DDims>
571KOKKOS_FUNCTION constexpr DiscreteElement<QueryDDims...> back(
572 StridedDiscreteDomain<DDims...> const& domain) noexcept
573{
574 return DiscreteElement<QueryDDims...>(StridedDiscreteDomain<QueryDDims>(domain).back()...);
575}
576
577template <class DDim>
579{
580private:
581 DiscreteElement<DDim> m_value = DiscreteElement<DDim>();
582
583 DiscreteVector<DDim> m_stride = DiscreteVector<DDim>();
584
585public:
586 using iterator_category = std::random_access_iterator_tag;
587
588 using value_type = DiscreteElement<DDim>;
589
590 using difference_type = std::ptrdiff_t;
591
592 KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomainIterator() = default;
593
594 KOKKOS_FUNCTION constexpr explicit StridedDiscreteDomainIterator(
595 DiscreteElement<DDim> value,
596 DiscreteVector<DDim> stride)
597 : m_value(value)
598 , m_stride(stride)
599 {
600 }
601
602 KOKKOS_FUNCTION constexpr DiscreteElement<DDim> operator*() const noexcept
603 {
604 return m_value;
605 }
606
607 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator++()
608 {
609 m_value += m_stride;
610 return *this;
611 }
612
613 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator++(int)
614 {
615 auto tmp = *this;
616 ++*this;
617 return tmp;
618 }
619
620 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator--()
621 {
622 m_value -= m_stride;
623 return *this;
624 }
625
626 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator--(int)
627 {
628 auto tmp = *this;
629 --*this;
630 return tmp;
631 }
632
633 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator+=(difference_type n)
634 {
635 if (n >= static_cast<difference_type>(0)) {
636 m_value += static_cast<DiscreteElementType>(n) * m_stride;
637 } else {
638 m_value -= static_cast<DiscreteElementType>(-n) * m_stride;
639 }
640 return *this;
641 }
642
643 KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator& operator-=(difference_type n)
644 {
645 if (n >= static_cast<difference_type>(0)) {
646 m_value -= static_cast<DiscreteElementType>(n) * m_stride;
647 } else {
648 m_value += static_cast<DiscreteElementType>(-n) * m_stride;
649 }
650 return *this;
651 }
652
653 KOKKOS_FUNCTION constexpr DiscreteElement<DDim> operator[](difference_type n) const
654 {
655 return m_value + n * m_stride;
656 }
657
658 friend KOKKOS_FUNCTION constexpr bool operator==(
661 {
662 return xx.m_value == yy.m_value;
663 }
664
665#if !defined(__cpp_impl_three_way_comparison) || __cpp_impl_three_way_comparison < 201902L
666 // In C++20, `a!=b` shall be automatically translated by the compiler to `!(a==b)`
667 friend KOKKOS_FUNCTION constexpr bool operator!=(
670 {
671 return xx.m_value != yy.m_value;
672 }
673#endif
674
675 friend KOKKOS_FUNCTION constexpr bool operator<(
678 {
679 return xx.m_value < yy.m_value;
680 }
681
682 friend KOKKOS_FUNCTION constexpr bool operator>(
685 {
686 return yy < xx;
687 }
688
689 friend KOKKOS_FUNCTION constexpr bool operator<=(
692 {
693 return !(yy < xx);
694 }
695
696 friend KOKKOS_FUNCTION constexpr bool operator>=(
699 {
700 return !(xx < yy);
701 }
702
703 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(
705 difference_type n)
706 {
707 return i += n;
708 }
709
710 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator+(
711 difference_type n,
713 {
714 return i += n;
715 }
716
717 friend KOKKOS_FUNCTION constexpr StridedDiscreteDomainIterator operator-(
719 difference_type n)
720 {
721 return i -= n;
722 }
723
724 friend KOKKOS_FUNCTION constexpr difference_type operator-(
727 {
728 return (yy.m_value > xx.m_value) ? (-static_cast<difference_type>(yy.m_value - xx.m_value))
729 : (xx.m_value - yy.m_value);
730 }
731};
732
733} // 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(int argc, char **&argv)
ScopeGuard(ScopeGuard &&x) noexcept=delete
ScopeGuard & operator=(ScopeGuard &&x) noexcept=delete
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_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 decltype(auto) operator[](std::size_t n) const
SparseDiscreteDomain(Kokkos::View< DiscreteElement< DDims > *, Kokkos::SharedSpace > const &... views)
Construct a SparseDiscreteDomain with Kokkos::View explicitly listing the discrete elements.
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 decltype(auto) operator[](std::size_t n)
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 SparseDiscreteDomain(DDoms const &... domains)
Construct a SparseDiscreteDomain by copies and merge of domains.
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 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 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 constexpr decltype(auto) operator[](std::size_t n)
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_FUNCTION constexpr decltype(auto) operator[](std::size_t n) const
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain(StridedDiscreteDomain const &x)=default
KOKKOS_FUNCTION constexpr bool operator==(StridedDiscreteDomain< ODims... > const &other) const
static KOKKOS_FUNCTION constexpr std::size_t rank()
KOKKOS_FUNCTION constexpr StridedDiscreteDomain(DDoms const &... domains)
Construct a StridedDiscreteDomain by copies and merge of domains.
KOKKOS_FUNCTION constexpr bool empty() const noexcept
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.
constexpr bool is_non_uniform_point_sampling_v
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > back(SparseDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION constexpr DiscreteElement< QueryDDims... > front(StridedDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rlength(DiscreteDomain< DDim > const &d)
bool is_discrete_space_initialized() noexcept
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > coordinate(DiscreteElement< DDim > const &c)
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > distance_at_left(DiscreteElement< DDim > i)
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > origin() noexcept
Lower bound index of the mesh.
KOKKOS_FUNCTION constexpr SparseDiscreteDomain< QueryDDims... > select(SparseDiscreteDomain< DDims... > const &domain)
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDims... > extents(StridedDiscreteDomain< DDims... > const &domain) noexcept
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rmin(DiscreteDomain< DDim > const &d)
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.
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > distance_at_right(DiscreteElement< DDim > i)
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
constexpr bool is_strided_discrete_domain_v
KOKKOS_FUNCTION DiscreteVector< ODDims... > prod(DiscreteVector< ODDims... > const &lhs, DiscreteVector< ODDims... > const &rhs) noexcept
constexpr bool is_periodic_sampling_v
KOKKOS_FUNCTION Real step() noexcept
Spacing step of the mesh.
KOKKOS_FUNCTION constexpr auto replace_dim_of(StridedDiscreteDomain< DDimsA... > const &DDom_a, StridedDiscreteDomain< DDimsB... > const &DDom_b) noexcept
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 DiscreteElement< DDim > front() noexcept
Lower bound index of the mesh.
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.
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.
KOKKOS_FUNCTION Coordinate< typename DDim::continuous_dimension_type > rmax(DiscreteDomain< DDim > const &d)
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)