kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

include/ruby/internal/arithmetic/long_long.h: add doxygen

Browse source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-01-21 15:43:07 +09:00
parent e9c423ac6c
commit abd15ac775
Notes: git 2021-09-10 20:01:21 +09:00
1 changed files with 71 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

83
include/ruby/internal/arithmetic/long_long.h
View file

@ -25,22 +25,59 @@
#include "ruby/internal/special_consts.h" #include "ruby/internal/special_consts.h"
#include "ruby/backward/2/long_long.h" #include "ruby/backward/2/long_long.h"
#define RB_LL2NUM rb_ll2num_inline #define RB_LL2NUM rb_ll2num_inline /**< @alias{rb_ll2num_inline} */
#define RB_ULL2NUM rb_ull2num_inline #define RB_ULL2NUM rb_ull2num_inline /**< @alias{rb_ull2num_inline} */
#define LL2NUM RB_LL2NUM #define LL2NUM RB_LL2NUM /**< @old{RB_LL2NUM} */
#define ULL2NUM RB_ULL2NUM #define ULL2NUM RB_ULL2NUM /**< @old{RB_ULL2NUM} */
#define RB_NUM2LL rb_num2ll_inline #define RB_NUM2LL rb_num2ll_inline /**< @alias{rb_num2ll_inline} */
#define RB_NUM2ULL rb_num2ull_inline #define RB_NUM2ULL rb_num2ull_inline /**< @alias{rb_num2ull_inline} */
#define NUM2LL RB_NUM2LL #define NUM2LL RB_NUM2LL /**< @old{RB_NUM2LL} */
#define NUM2ULL RB_NUM2ULL #define NUM2ULL RB_NUM2ULL /**< @old{RB_NUM2ULL} */
RBIMPL_SYMBOL_EXPORT_BEGIN() RBIMPL_SYMBOL_EXPORT_BEGIN()
VALUE rb_ll2inum(LONG_LONG); /**
VALUE rb_ull2inum(unsigned LONG_LONG); * Converts a C's `long long` into an instance of ::rb_cInteger.
LONG_LONG rb_num2ll(VALUE); *
unsigned LONG_LONG rb_num2ull(VALUE); * @param[in] num Arbitrary `long long` value.
* @return An instance of ::rb_cInteger.
*/
VALUE rb_ll2inum(LONG_LONG num);
/**
* Converts a C's `unsigned long long` into an instance of ::rb_cInteger.
*
* @param[in] num Arbitrary `unsigned long long` value.
* @return An instance of ::rb_cInteger.
*/
VALUE rb_ull2inum(unsigned LONG_LONG num);
/**
* Converts an instance of ::rb_cNumeric into C's `long long`.
*
* @param[in] num Something numeric.
* @exception rb_eTypeError `num` is not a numeric.
* @exception rb_eRangeError `num` is out of range of `long long`.
* @return The passed value converted into C's `long long`.
*/
LONG_LONG rb_num2ll(VALUE num);
/**
* Converts an instance of ::rb_cNumeric into C's `unsigned long long`.
*
* @param[in] num Something numeric.
* @exception rb_eTypeError `num` is not a numeric.
* @exception rb_eRangeError `num` is out of range of `unsigned long long`.
* @return The passed value converted into C's `unsigned long long`.
*/
unsigned LONG_LONG rb_num2ull(VALUE num);
RBIMPL_SYMBOL_EXPORT_END() RBIMPL_SYMBOL_EXPORT_END()
/**
* Converts a C's `long long` into an instance of ::rb_cInteger.
*
* @param[in] n Arbitrary `long long` value.
* @return An instance of ::rb_cInteger
*/
static inline VALUE static inline VALUE
rb_ll2num_inline(LONG_LONG n) rb_ll2num_inline(LONG_LONG n)
{ {
@ -48,6 +85,12 @@ rb_ll2num_inline(LONG_LONG n)
return rb_ll2inum(n); return rb_ll2inum(n);
} }
/**
* Converts a C's `unsigned long long` into an instance of ::rb_cInteger.
*
* @param[in] n Arbitrary `unsigned long long` value.
* @return An instance of ::rb_cInteger
*/
static inline VALUE static inline VALUE
rb_ull2num_inline(unsigned LONG_LONG n) rb_ull2num_inline(unsigned LONG_LONG n)
{ {
@ -55,6 +98,14 @@ rb_ull2num_inline(unsigned LONG_LONG n)
return rb_ull2inum(n); return rb_ull2inum(n);
} }
/**
* Converts an instance of ::rb_cNumeric into C's `long long`.
*
* @param[in] x Something numeric.
* @exception rb_eTypeError `x` is not a numeric.
* @exception rb_eRangeError `x` is out of range of `long long`.
* @return The passed value converted into C's `long long`.
*/
static inline LONG_LONG static inline LONG_LONG
rb_num2ll_inline(VALUE x) rb_num2ll_inline(VALUE x)
{ {
@ -64,6 +115,14 @@ rb_num2ll_inline(VALUE x)
return rb_num2ll(x); return rb_num2ll(x);
} }
/**
* Converts an instance of ::rb_cNumeric into C's `unsigned long long`.
*
* @param[in] x Something numeric.
* @exception rb_eTypeError `x` is not a numeric.
* @exception rb_eRangeError `x` is out of range of `unsigned long long`.
* @return The passed value converted into C's `unsigned long long`.
*/
static inline unsigned LONG_LONG static inline unsigned LONG_LONG
rb_num2ull_inline(VALUE x) rb_num2ull_inline(VALUE x)
{ {