24 Containers library [containers]

24.7 Views [views]

24.7.3 Multidimensional access [views.multidim]

24.7.3.4 Layout mapping [mdspan.layout]

24.7.3.4.9 Class template layout_right_padded​::​mapping [mdspan.layout.rightpad]

24.7.3.4.9.3 Constructors [mdspan.layout.rightpad.cons]

🔗
constexpr mapping(const extents_type& ext);
1
#
Preconditions:
  • (1.1)
    The size of the multidimensional index space ext is representable as a value of type index_type.
  • (1.2)
    If rank_ is greater than one and padding_value does not equal dynamic_extent, then LEAST-MULTIPLE-AT-LEAST(padding_value, ext.extent(rank_ - 1)) is representable as a value of type index_type.
  • (1.3)
    If rank_ is greater than one and padding_value does not equal dynamic_extent, then the product of LEAST-MULTIPLE-AT-LEAST(padding_value, ext.extent(rank_ - 1)) and all values ext.extent(k) with k in the range of [0, rank_ - 1) is representable as a value of type index_type.
2
#
Effects:
  • (2.1)
    Direct-non-list-initializes extents_ with ext; and
  • (2.2)
    if rank_ is greater than one, direct-non-list-initializes stride-rm2
    • (2.2.1)
      with ext.extent(rank_ - 1) if padding_value is dynamic_extent,
    • (2.2.2)
      otherwise with LEAST-MULTIPLE-AT-LEAST(padding_value, ext.extent(rank_ - 1)).
🔗
template<class OtherIndexType> constexpr mapping(const extents_type& ext, OtherIndexType pad);
3
#
Constraints:
  • (3.1)
    is_convertible_v<OtherIndexType, index_type> is true.
  • (3.2)
    is_nothrow_constructible_v<index_type, OtherIndexType> is true.
4
#
Preconditions:
  • (4.1)
    pad is representable as a value of type index_type.
  • (4.2)
    extents_type​::​index-cast(pad) is greater than zero.
  • (4.3)
    If rank_ is greater than one, then LEAST-MULTIPLE-AT-LEAST(pad, ext.extent(rank_ - 1)) is representable as a value of type index_type.
  • (4.4)
    If rank_ is greater than one, then the product of LEAST-MULTIPLE-AT-LEAST(pad, ext.extent(
    rank_     - 1))     and all values ext.extent(k) with k in the range of [0, rank_ - 1) is representable as a value of type index_type.
  • (4.5)
    If padding_value is not equal to dynamic_extent, padding_value equals extents_type​::​
    index-cast(pad)    .
5
#
Effects: Direct-non-list-initializes extents_ with ext, and if rank_ is greater than one, direct-non-list-initializes stride-rm2 with LEAST-MULTIPLE-AT-LEAST(pad, ext.extent(rank_ - 1)).
🔗
template<class OtherExtents> constexpr explicit(!is_convertible_v<OtherExtents, extents_type>) mapping(const layout_right::mapping<OtherExtents>& other);
6
#
Constraints: is_constructible_v<extents_type, OtherExtents> is true.
7
#
Mandates: If OtherExtents​::​rank() is greater than 1, then (static-padding-stride == dynamic_extent) || (OtherExtents::static_extent(rank_ - 1) == dynamic_extent) || (static-padding-stride == OtherExtents::static_extent(rank_ - 1)) is true.
8
#
Preconditions:
  • (8.1)
    If rank_ > 1 is true and padding_value == dynamic_extent is false, then other.stride(
    rank_ - 2)     equals LEAST-MULTIPLE-AT-LEAST(padding_value, extents_type::index-cast(other.extents().extent(rank_ - 1))) and
  • (8.2)
    other.required_span_size() is representable as a value of type index_type.
9
#
Effects: Equivalent to mapping(other.extents()).
🔗
template<class OtherExtents> constexpr explicit(rank_ > 0) mapping(const layout_stride::mapping<OtherExtents>& other);
10
#
Constraints: is_constructible_v<extents_type, OtherExtents> is true.
11
#
Preconditions:
  • (11.1)
    If rank_ is greater than 1 and padding_value does not equal dynamic_extent, then other.
    stride(rank_ - 2)     equals LEAST-MULTIPLE-AT-LEAST(padding_value, extents_type::index-cast(other.extents().extent(rank_ - 1)))
  • (11.2)
    If rank_ is greater than 0, then other.stride(rank_ - 1) equals 1.
  • (11.3)
    If rank_ is greater than 2, then for all r in the range [0, rank_ - 2), other.stride(r) equals (other.extents().rev-prod-of-extents(r) / other.extents().extent(rank_ - 1)) * other.stride(rank_ - 2)
  • (11.4)
    other.required_span_size() is representable as a value of type index_type.
12
#
Effects:
  • (12.1)
    Direct-non-list-initializes extents_ with other.extents(); and
  • (12.2)
    if rank_ is greater than one, direct-non-list-initializes stride-rm2 with other.stride(rank_ - 2).
🔗
template<class LayoutRightPaddedMapping> constexpr explicit( see below ) mapping(const LayoutRightPaddedMapping& other);
13
#
Constraints:
  • (13.1)
    is-layout-right-padded-mapping-of<LayoutRightPaddedMapping> is true.
  • (13.2)
    is_constructible_v<extents_type, typename LayoutRightPaddedMapping​::​extents_-
    type>     is true.
14
#
Mandates: If rank_ is greater than 1, then padding_value == dynamic_extent || LayoutRightPaddedMapping::padding_value == dynamic_extent || padding_value == LayoutRightPaddedMapping::padding_value is true.
15
#
Preconditions:
  • (15.1)
    If rank_ is greater than 1 and padding_value does not equal dynamic_extent, then other.
    stride(rank_ - 2)     equals LEAST-MULTIPLE-AT-LEAST(padding_value, extents_type::index-cast(other.extent(rank_ - 1)))
  • (15.2)
    other.required_span_size() is representable as a value of type index_type.
16
#
Effects:
  • (16.1)
    Direct-non-list-initializes extents_ with other.extents(); and
  • (16.2)
    if rank_ is greater than one, direct-non-list-initializes stride-rm2 with other.stride(rank_ - 2).
17
#
Remarks: The expression inside explicit is equivalent to: rank_ > 1 && (padding_value != dynamic_extent || LayoutRightPaddedMapping::padding_value == dynamic_extent)
🔗
template<class LayoutLeftPaddedMapping> constexpr explicit( see below ) mapping(const LayoutLeftPaddedMapping& other) noexcept;
18
#
Constraints:
  • (18.1)
    is-layout-left-padded-mapping-of<LayoutLeftPaddedMapping> is true or
    is-mapping-of<layout_left, LayoutLeftPaddedMapping> is true.
  • (18.2)
    rank_ equals zero or one.
  • (18.3)
    is_constructible_v<extents_type, typename LayoutLeftPaddedMapping​::​extents_type>
    is true.
19
#
Preconditions: other.required_span_size() is representable as a value of type index_type.
20
#
Effects: Direct-non-list-initializes extents_ with other.extents().
21
#
Remarks: The expression inside explicit is equivalent to: !is_convertible_v<typename LayoutLeftPaddedMapping::extents_type, extents_type>
[Note 1: 
Neither the input mapping nor the mapping to be constructed uses the padding stride in the rank-0 or rank-1 case, so the padding stride affects neither the constraints nor the preconditions.
— end note]