Skip to content
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

Jump to bottom

Doc v2 u2z #1889

Merged
merged 1 commit into from
Jul 17, 2024
+30 −19
Merged

Doc v2 u2z #1889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 15 additions & 11 deletions include/eve/module/core/regular/ulpdist.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ namespace eve
//! @var ulpdist
//! @brief Computes the unit in the last place distance of its arguments.
//!
//! **Defined in Header**
//! @groupheader{Header file}
//!
//! @code
//! #include <eve/module/core.hpp>
Expand All @@ -49,26 +49,30 @@ namespace eve
//! @code
//! namespace eve
//! {
//! template< eve::value T, eve::value U >
//! eve::common_value_t<T, U> ulpdist(T x, U y) noexcept;
//! // Regular overload
//! constexpr auto ulpdist(floating_value auto x, floating_value auto y) noexcept; // 1
//!
//! // Lanes masking
//! constexpr auto ulpdist[conditional_expr auto c][floating_value auto x, floating_value auto y) noexcept; // 3
//! constexpr auto ulpdist[logical_value auto m](floating_value auto x, floating_value auto y) noexcept; // 3
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x`, `y` : [arguments](@ref eve::value).
//! * `x`, `y`: [arguments](@ref eve::value).
//! * `c`: [Conditional expression](@ref conditional_expr) masking the operation.
//! * `m`: [Logical value](@ref logical) masking the operation.
//!
//! **Return value**
//!
//! Computes [elementwise](@ref glossary_elementwise) the
//! 'units in the last place' distance
//! between `x` and `y`. This is semantically equivalent to:`
//!
//! * if is_ordered(x,y), nb_values(x,y)/2.0 is returned
//! * otherwise a `Nan` is returned
//! 1. Computes [elementwise](@ref glossary_elementwise) the 'units in the last place' distance
//! between `x` and `y`.
//! * if is_ordered(x,y), nb_values(x,y)/2.0 is returned
//! * otherwise a `Nan` is returned
//! 2. [The operation is performed conditionnaly](@ref conditional).
//!
//! @groupheader{Example}
//!
//! @godbolt{doc/core/ulpdist.cpp}
//!
//! @}
Expand Down
2 changes: 1 addition & 1 deletion include/eve/module/core/regular/unalign.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ namespace eve

EVE_CALLABLE_OBJECT(unalign_t, unalign_);
};

// TODO DOC
//================================================================================================
//! @addtogroup memory
//! @{
Expand Down
1 change: 1 addition & 0 deletions include/eve/module/core/regular/zip.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ namespace eve
struct filler { EVE_FORCEINLINE auto operator()(auto in, auto *ptr) const { *ptr = in; } };
};

// TODO DOC
//================================================================================================
//! @addtogroup core_simd
//! @{
Expand Down
20 changes: 13 additions & 7 deletions include/eve/module/special/regular/zeta.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace eve
//! @var zeta
//! @brief Computes the Riemann \f$\zeta\f$ function.
//!
//! **Defined in header**
//! @groupheader{Header file}
//!
//! @code
//! #include <eve/module/special.hpp>
Expand All @@ -41,22 +41,28 @@ namespace eve
//! @code
//! namespace eve
//! {
//! template< eve::floating_ordered_value T >
//! T zeta(T x) noexcept;
//! // Regular overload
//! constexpr auto zeta(floating_value auto x) noexcept; // 1
//!
//! // Lanes masking
//! constexpr auto zeta[conditional_expr auto c](floating_value auto x) noexcept; // 2
//! constexpr auto zeta[logical_value auto m](floating_value auto x) noexcept; // 2
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x` : [real floating argument](@ref eve::floating_ordered_value).
//! * `x`: [floating value](@ref floating_value).
//! * `c`: [Conditional expression](@ref conditional_expr) masking the operation.
//! * `m`: [Logical value](@ref logical) masking the operation.
//!
//! **Return value**
//!
//! The value of the Riemann function defined as
//! \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ is returned.
//! 1. The value of the Riemann function defined as
//! \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ is returned.
//! 2. [The operation is performed conditionnaly](@ref conditional).
//!
//! @groupheader{Example}
//!
//! @godbolt{doc/special/regular/zeta.cpp}
//! @}
//================================================================================================
Expand Down