Skip to content

[SYCL][DOC] Update marray specification #12786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jle-quel wants to merge 6 commits into
base: sycl
Choose a base branch
from
Open

[SYCL][DOC] Update marray specification #12786

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ff1f4e3
Apply clang-format on inline code
jle-quel Feb 21, 2024
300a22e
Include notes and declarations for operators requiring implementation
jle-quel Feb 21, 2024
3b35704
Add missing deleted operators and remove unnecessary addition of oper…
jle-quel Feb 21, 2024
7147da4
Reorder required implementation to follow the complex order and reord…
jle-quel Feb 21, 2024
04583dd
Clarify the comments to be more specific
jle-quel Mar 19, 2024
277b17f
Add missing space to comment
jle-quel Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 128 additions & 46 deletions sycl/doc/extensions/experimental/sycl_ext_oneapi_complex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,16 @@ public:
This proposal also introduces the specialization of the `sycl::marray` class to
support SYCL `complex`. The `marray` class undergoes slight modification for
this specialization, primarily involving the removal of operators that are
inapplicable. No new functions or operators are introduced to the `marray`
class.
inapplicable and implementing the operators that are *only* supported by
`complex<T>`.
No new functions or operators are introduced to the `marray` class.

The `complex`'s `marray` specialization maintains the principles of trivial
copyability (as seen in the <<Complex Class, `complex` class description>>),
with the `is_device_copyable` type trait resolving to `std::true_type`.

The `marray` specialization for `complex<T>` deletes any operator that is not
supported by `complex<T>`.
supported by `complex<T>` and implements the ones supported.

```C++
namespace sycl {
Expand All @@ -248,74 +249,155 @@ public:

/* ... */

friend marray operator %(const marray &lhs, const marray &rhs) = delete;
friend marray operator %(const marray &lhs, const value_type &rhs) = delete;
friend marray operator %(const value_type &lhs, const marray &rhs) = delete;
/// Adds and assigns marray rhs to marray lhs.
friend marray &operator +=(marray &lhs, const marray &rhs);
/// Adds and assigns complex number rhs to marray lhs.
friend marray &operator +=(marray &lhs, const value_type &rhs);

/// Subtracts and assigns marray rhs to marray lhs.
friend marray &operator -=(marray &lhs, const marray &rhs);
/// Subtracts and assigns complex number rhs to marray lhs.
friend marray &operator -=(marray &lhs, const value_type &rhs);

/// Multiplies and assigns marray rhs to marray lhs.
friend marray &operator *=(marray &lhs, const marray &rhs);
/// Multiplies and assigns complex number rhs to marray lhs.
friend marray &operator *=(marray &lhs, const value_type &rhs);

/// Divides and assigns marray rhs to marray lhs.
friend marray &operator /=(marray &lhs, const marray &rhs);
/// Divides and assigns complex number rhs to marray lhs.
friend marray &operator /=(marray &lhs, const value_type &rhs);

/// Adds marray rhs and marray lhs and returns the result.
friend marray operator +(const marray &lhs, const marray &rhs);
/// Adds complex number rhs and marray lhs and returns the result.
friend marray operator +(const marray &lhs, const value_type &rhs);
/// Adds marray rhs and complex number lhs and returns the result.
friend marray operator +(const value_type &lhs, const marray &rhs);
/// Returns a copy of the input marray.
friend marray operator +(const marray &lhs);

/// Subtracts marray rhs and marray lhs and returns the result.
friend marray operator -(const marray &lhs, const marray &rhs);
/// Subtracts complex number rhs and marray lhs and returns the result.
friend marray operator -(const marray &lhs, const value_type &rhs);
/// Subtracts marray rhs and complex number lhs and returns the result.
friend marray operator -(const value_type &lhs, const marray &rhs);
/// Negates each element of the input marray.
friend marray operator -(const marray &lhs);

/// Mulitplies marray rhs and marray lhs and returns the result.
friend marray operator *(const marray &lhs, const marray &rhs);
/// Multiplies complex number rhs and marray lhs and returns the result.
friend marray operator *(const marray &lhs, const value_type &rhs);
/// Multiplies marray rhs and complex number lhs and returns the result.
friend marray operator *(const value_type &lhs, const marray &rhs);

/// Divides marray rhs and marray lhs and returns the result.
friend marray operator /(const marray &lhs, const marray &rhs);
/// Divides complex number rhs and marray lhs and returns the result.
friend marray operator /(const marray &lhs, const value_type &rhs);
/// Divides marray rhs and complex number lhs and returns the result.
friend marray operator /(const value_type &lhs, const marray &rhs);

/// Compares marray rhs and marray lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs are the same, otherwise false.
friend marray<bool, NumElements> operator ==(const marray &lhs, const marray &rhs);
/// Compares complex number rhs and marray lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs are the same, otherwise false.
friend marray<bool, NumElements> operator ==(const marray &lhs, const value_type &rhs);
/// Compares marray rhs and complex number lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs are the same, otherwise false.
friend marray<bool, NumElements> operator ==(const value_type &lhs, const marray &rhs);

/// Compares marray rhs and marray lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs differs, otherwise false.
friend marray<bool, NumElements> operator !=(const marray &lhs, const marray &rhs);
/// Compares complex number rhs and marray lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs differs, otherwise false.
friend marray<bool, NumElements> operator !=(const marray &lhs, const value_type &rhs);
/// Compares marray rhs and complex number lhs, returning an marray of booleans where each element is true if the corresponding elements in lhs and rhs dffers, otherwise false.
friend marray<bool, NumElements> operator !=(const value_type &lhs, const marray &rhs);

/* ... */

friend marray &operator %=(marray &lhs, const marray &rhs) = delete;
friend marray &operator %=(marray &lhs, const value_type &rhs) = delete;
friend marray &operator %=(value_type &lhs, const marray &rhs) = delete;

friend marray &operator &=(marray &lhs, const marray &rhs) = delete;
friend marray &operator &=(marray &lhs, const value_type &rhs) = delete;

friend marray &operator |=(marray &lhs, const marray &rhs) = delete;
friend marray &operator |=(marray &lhs, const value_type &rhs) = delete;

friend marray &operator ^=(marray &lhs, const marray &rhs) = delete;
friend marray &operator ^=(marray &lhs, const value_type &rhs) = delete;

friend marray &operator <<=(marray &lhs, const marray &rhs) = delete;
friend marray &operator <<=(marray &lhs, const value_type &rhs) = delete;

friend marray &operator >>=(marray &lhs, const marray &rhs) = delete;
friend marray &operator >>=(marray &lhs, const value_type &rhs) = delete;

friend marray &operator ++(marray &lhs) = delete;
friend marray operator ++(marray &lhs, int) = delete;
friend marray &operator ++(marray & rhs) = delete;

friend marray &operator --(marray &lhs) = delete;
friend marray operator --(marray &lhs, int) = delete;
friend marray &operator --(marray & rhs) = delete;

friend marray &operator +=(marray &lhs) = delete;
friend marray operator +=(marray &lhs, int) = delete;

friend marray &operator -=(marray &lhs) = delete;
friend marray operator -=(marray &lhs, int) = delete;

friend marray operator %(const marray &lhs, const marray &rhs) = delete;
friend marray operator %(const marray &lhs, const value_type &rhs) = delete;
friend marray operator %(const value_type &lhs, const marray &rhs) = delete;

friend marray operator ~(const marray &lhs) = delete;

friend marray operator &(const marray &lhs, const marray &rhs) = delete;
friend marray operator &(const marray &lhs, const value_type &rhs) = delete;
friend marray operator &(const value_type &lhs, const marray &rhs) = delete;

friend marray operator |(const marray &lhs, const marray &rhs) = delete;
friend marray operator |(const marray &lhs, const value_type &rhs) = delete;
friend marray operator |(const value_type &lhs, const marray &rhs) = delete;

friend marray operator ^(const marray &lhs, const marray &rhs) = delete;
friend marray operator ^(const marray &lhs, const value_type &rhs) = delete;
friend marray operator ^(const value_type &lhs, const marray &rhs) = delete;

friend marray &operator &=(marray & lhs, const marray & rhs) = delete;
friend marray &operator &=(marray & lhs, const value_type & rhs) = delete;
friend marray &operator &=(value_type & lhs, const marray & rhs) = delete;

friend marray &operator |=(marray & lhs, const marray & rhs) = delete;
friend marray &operator |=(marray & lhs, const value_type & rhs) = delete;
friend marray &operator |=(value_type & lhs, const marray & rhs) = delete;

friend marray &operator ^=(marray & lhs, const marray & rhs) = delete;
friend marray &operator ^=(marray & lhs, const value_type & rhs) = delete;
friend marray &operator ^=(value_type & lhs, const marray & rhs) = delete;

friend marray<bool, NumElements> operator <<(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator <<(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator <<(const value_type & lhs, const marray & rhs) = delete;

friend marray<bool, NumElements> operator >>(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator >>(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator >>(const value_type & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator <<(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator <<(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator <<(const value_type &lhs, const marray &rhs) = delete;

friend marray &operator <<=(marray & lhs, const marray & rhs) = delete;
friend marray &operator <<=(marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator >>(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator >>(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator >>(const value_type &lhs, const marray &rhs) = delete;

friend marray &operator >>=(marray & lhs, const marray & rhs) = delete;
friend marray &operator >>=(marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator !(const marray &lhs) = delete;

friend marray<bool, NumElements> operator <(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator <(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator <(const value_type & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator &&(const marray &lhs, const marray &hhs) = delete;
friend marray<bool, NumElements> operator &&(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator &&(const value_type &lhs, const marray &rhs) = delete;

friend marray<bool, NumElements> operator >(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator >(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator >(const value_type & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator ||(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator ||(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator ||(const value_type &lhs, const marray &rhs) = delete;

friend marray<bool, NumElements> operator <=(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator <=(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator <=(const value_type & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator <(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator <(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator <(const value_type &lhs, const marray &rhs) = delete;

friend marray<bool, NumElements> operator >=(const marray & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator >=(const marray & lhs, const value_type & rhs) = delete;
friend marray<bool, NumElements> operator >=(const value_type & lhs, const marray & rhs) = delete;
friend marray<bool, NumElements> operator >(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator >(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator >(const value_type &lhs, const marray &rhs) = delete;

friend marray operator ~(const marray &v) = delete;
friend marray<bool, NumElements> operator <=(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator <=(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator <=(const value_type &lhs, const marray &rhs) = delete;

friend marray<bool, NumElements> operator !(const marray &v) = delete;
friend marray<bool, NumElements> operator >=(const marray &lhs, const marray &rhs) = delete;
friend marray<bool, NumElements> operator >=(const marray &lhs, const value_type &rhs) = delete;
friend marray<bool, NumElements> operator >=(const value_type &lhs, const marray &rhs) = delete;
};

} // namespace sycl
Expand Down