GCC Code Coverage Report


Directory: include/polyfloat/
File: include/polyfloat/module/math/csch.hpp
Date: 2026-11-09 15:28:50
Exec Total Coverage
Lines: 5 5 100.0%
Functions: 28 28 100.0%
Branches: 0 0 -%

Line Branch Exec Source
1 //======================================================================================================================
2 /*
3 POLYFLOAT - Extended precision floating points
4 Copyright : POLYFLOAT Contributors & Maintainers
5 SPDX-License-Identifier: BSL-1.0
6 */
7 //======================================================================================================================
8 #pragma once
9
10 #include <polyfloat/details/callable.hpp>
11 #include <polyfloat/types/concepts.hpp>
12 #include <polyfloat/types/traits.hpp>
13 #include <type_traits>
14 #include <polyfloat/module/math/sinh.hpp>
15
16 namespace plf
17 {
18
19 template<typename Options>
20 struct csch_t : plf::elementwise_callable<csch_t, eve::csch_t, Options, raw_option, pedantic_option>
21 {
22 84 template<concepts::polyfloat_like Z> POLYFLOAT_ABI constexpr Z operator()(Z z) const noexcept
23 {
24 84 return POLYFLOAT_CALL(z);
25 }
26
27 74 POLYFLOAT_CALLABLE_OBJECT(csch_t, csch_);
28 };
29 //======================================================================================================================
30 //! @addtogroup math
31 //! @{
32 //! @var csch
33 //! @brief return the hyperbolic cosecant value.
34 //!
35 //! @groupheader{Header file}
36 //!
37 //! @code
38 //! #include <polyfloat/math.hpp>
39 //! @endcode
40 //!
41 //! @groupheader{Callable Signatures}
42 //!
43 //! @code
44 //! namespace polyfloat
45 //! {
46 //! template<polyfloat::concepts::polyfloat_like T> constexpr auto csch(T z) noexcept;
47 //! }
48 //! @endcode
49 //!
50 //! **Parameters**
51 //!
52 //! * `z`: Value to process.
53 //!
54 //! **Return value**
55 //!
56 //! Returns the hyperbolic cosecant of z.
57 //!
58 //! @groupheader{Example}
59 //!
60 //! @godbolt{doc/math/csch.cpp}
61 //======================================================================================================================
62
63 inline constexpr auto csch = eve::functor<csch_t>;
64 //======================================================================================================================
65 //! @}
66 //======================================================================================================================
67 }
68
69 namespace plf::_
70 {
71 74 template<typename T, eve::callable_options O> constexpr auto csch_(POLYFLOAT_DELAY(), O const& o, T a0) noexcept
72 {
73 74 return plf::rec[pedantic](plf::sinh[o](a0));
74 }
75 }
76