Ruby 4.1.0dev (2026-03-15 revision ca23c7c404871abec5acfedf35843387148350d8)
rational.h
1#ifndef INTERNAL_RATIONAL_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_RATIONAL_H
11#include "ruby/internal/config.h" /* for HAVE_LIBGMP */
12#include "ruby/ruby.h" /* for struct RBasic */
13#include "internal/numeric.h" /* for INT_POSITIVE_P */
14#include "ruby_assert.h" /* for assert */
15
16struct RRational {
17 struct RBasic basic;
18 VALUE num;
19 VALUE den;
20};
21
22#define RRATIONAL(obj) ((struct RRational *)(obj))
23
24/* rational.c */
25VALUE rb_rational_canonicalize(VALUE x);
26VALUE rb_rational_uminus(VALUE self);
27VALUE rb_rational_plus(VALUE self, VALUE other);
28VALUE rb_rational_minus(VALUE self, VALUE other);
29VALUE rb_rational_mul(VALUE self, VALUE other);
30VALUE rb_rational_div(VALUE self, VALUE other);
31VALUE rb_rational_fdiv(VALUE self, VALUE other);
32VALUE rb_lcm(VALUE x, VALUE y);
33VALUE rb_rational_reciprocal(VALUE x);
34VALUE rb_cstr_to_rat(const char *, int);
35VALUE rb_rational_hash(VALUE self);
36VALUE rb_rational_abs(VALUE self);
37VALUE rb_rational_cmp(VALUE self, VALUE other);
38VALUE rb_rational_pow(VALUE self, VALUE other);
39VALUE rb_rational_floor(VALUE self, int ndigits);
40VALUE rb_numeric_quo(VALUE x, VALUE y);
41VALUE rb_flo_round_by_rational(int argc, VALUE *argv, VALUE num);
42VALUE rb_float_numerator(VALUE x);
43VALUE rb_float_denominator(VALUE x);
44
45static inline void RATIONAL_SET_NUM(VALUE r, VALUE n);
46static inline void RATIONAL_SET_DEN(VALUE r, VALUE d);
47
48RUBY_SYMBOL_EXPORT_BEGIN
49/* rational.c (export) */
50VALUE rb_gcd(VALUE x, VALUE y);
51VALUE rb_gcd_normal(VALUE self, VALUE other);
52#if defined(HAVE_LIBGMP) && defined(HAVE_GMP_H)
53VALUE rb_gcd_gmp(VALUE x, VALUE y);
54#endif
55RUBY_SYMBOL_EXPORT_END
56
57static inline void
58RATIONAL_SET_NUM(VALUE r, VALUE n)
59{
60 assert(RB_INTEGER_TYPE_P(n));
61 RB_OBJ_WRITE(r, &RRATIONAL(r)->num, n);
62}
63
64static inline void
65RATIONAL_SET_DEN(VALUE r, VALUE d)
66{
67 assert(RB_INTEGER_TYPE_P(d));
68 assert(INT_POSITIVE_P(d));
69 RB_OBJ_WRITE(r, &RRATIONAL(r)->den, d);
70}
71
72inline static bool
73f_zero_p(VALUE x)
74{
75 if (RB_INTEGER_TYPE_P(x)) {
76 return FIXNUM_ZERO_P(x);
77 }
78 else if (RB_FLOAT_TYPE_P(x)) {
79 return FLOAT_ZERO_P(x);
80 }
81 else if (RB_TYPE_P(x, T_RATIONAL)) {
82 const VALUE num = RRATIONAL(x)->num;
83 return FIXNUM_ZERO_P(num);
84 }
85 return rb_equal(x, INT2FIX(0)) != 0;
86}
87
88#define f_nonzero_p(x) (!f_zero_p(x))
89
90#endif /* INTERNAL_RATIONAL_H */
#define RB_INTEGER_TYPE_P
Old name of rb_integer_type_p.
Definition value_type.h:87
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
Definition value_type.h:76
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
Definition object.c:176
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
Ruby object's base components.
Definition rbasic.h:69
Internal header for Rational.
Definition rational.h:16
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static bool RB_FLOAT_TYPE_P(VALUE obj)
Queries if the object is an instance of rb_cFloat.
Definition value_type.h:264
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376