12
12
/**
13
13
* <p><b>This class is largely obsolete. It will be replaced by a new version
14
14
* of this class in a different namespace/package and library, called
15
- * <code>PeterO.Numbers.ERational</code> in the <code>PeterO.Numbers</code> library
16
- * (in .NET), or <code>com.upokecenter.numbers.getERational()</code> in the
17
- * <code>com.github.peteroupc/numbers</code> artifact (in Java). This new
18
- * class can be used in the <code>CBORObject.FromObject(Object)</code> method
19
- * (by including the new library in your code, among other things), but
20
- * this version of the CBOR library doesn't include any methods that
21
- * explicitly take an <code>ERational</code> as a parameter or return
15
+ * <code>PeterO.Numbers.ERational</code> in the <a
16
+ * href='https://www.nuget.org/packages/PeterO.Numbers'><code>PeterO.Numbers</code></a>
17
+ * library (in .NET), or <code>com.upokecenter.numbers.ERational</code> in the
18
+ * <a
19
+ * href='https://github.com/peteroupc/numbers-java'><code>com.github.peteroupc/numbers</code></a>
20
+ * artifact (in Java). This new class can be used in the
21
+ * <code>CBORObject.FromObject(Object)</code> method (by including the new
22
+ * library in your code, among other things), but this version of the
23
+ * CBOR library doesn't include any methods that explicitly take an
24
+ * <code>ERational</code> as a parameter or return
22
25
* value.</b></p>Arbitrary-precision rational number. This class cannot
23
26
* be inherited; this is a change in version 2.0 from previous versions,
24
27
* where the class was inadvertently left inheritable. <p><b>Thread
@@ -112,7 +115,7 @@ public final BigInteger getDenominator() {
112
115
113
116
/**
114
117
* Gets a value indicating whether this object is finite (not infinity or NaN).
115
- * @return True if this object is finite (not infinity or NaN); otherwise,
118
+ * @return true if this object is finite (not infinity or NaN); otherwise,
116
119
* false.
117
120
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
118
121
*/
@@ -124,15 +127,15 @@ public final boolean isFinite() {
124
127
/**
125
128
* Gets a value indicating whether this object's value is negative (including
126
129
* negative zero).
127
- * @return True if this object's value is negative; otherwise, false.
130
+ * @return true if this object's value is negative, otherwise, false.
128
131
*/
129
132
public final boolean isNegative () {
130
133
return this .getEr ().isNegative ();
131
134
}
132
135
133
136
/**
134
137
* Gets a value indicating whether this object's value equals 0.
135
- * @return True if this object's value equals 0; otherwise, false.
138
+ * @return true if this object's value equals 0, otherwise, false.
136
139
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
137
140
*/
138
141
@ Deprecated
@@ -290,7 +293,7 @@ public static ExtendedRational FromExtendedDecimal(ExtendedDecimal ef) {
290
293
}
291
294
292
295
/**
293
- * Not documented yet .
296
+ * Converts an arbitrary-precision binary float to a rational number .
294
297
* @param ef An arbitrary-precision binary float.
295
298
* @return An arbitrary-precision rational number.
296
299
* @throws java.lang.NullPointerException The parameter {@code ef} is null.
@@ -305,7 +308,7 @@ public static ExtendedRational FromExtendedFloat(ExtendedFloat ef) {
305
308
}
306
309
307
310
/**
308
- * Not documented yet .
311
+ * Converts a 32-bit signed integer to a rational number .
309
312
* @param smallint A 32-bit signed integer.
310
313
* @return An arbitrary-precision rational number.
311
314
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
@@ -316,7 +319,7 @@ public static ExtendedRational FromInt32(int smallint) {
316
319
}
317
320
318
321
/**
319
- * Not documented yet .
322
+ * Converts a 64-bit signed integer to a rational number .
320
323
* @param longInt A 64-bit signed integer.
321
324
* @return An arbitrary-precision rational number.
322
325
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
@@ -435,17 +438,19 @@ public ExtendedRational Divide(ExtendedRational otherValue) {
435
438
/**
436
439
* Determines whether this object and another object are equal.
437
440
* @param obj An arbitrary object.
438
- * @return True if the objects are equal; otherwise, false.
441
+ * @return true if the objects are equal; otherwise, false.
439
442
*/
440
443
@ Override public boolean equals (Object obj ) {
441
444
ExtendedRational bi = ((obj instanceof ExtendedRational ) ? (ExtendedRational )obj : null );
442
445
return (bi == null ) ? false : this .getEr ().equals (bi .getEr ());
443
446
}
444
447
445
448
/**
446
- * Not documented yet.
447
- * @param other An arbitrary-precision rational number.
448
- * @return A Boolean object.
449
+ * Returns whether this object's properties are equal to the properties of
450
+ * another rational number object.
451
+ * @param other Another arbitrary-precision rational number.
452
+ * @return true if this object's properties are equal to the properties of
453
+ * another rational number object; otherwise, false.
449
454
* @throws java.lang.NullPointerException The parameter {@code other} is null.
450
455
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
451
456
*/
@@ -467,7 +472,7 @@ public boolean equals(ExtendedRational other) {
467
472
468
473
/**
469
474
* Gets a value indicating whether this object's value is infinity.
470
- * @return True if this object's value is infinity; otherwise, false.
475
+ * @return true if this object's value is infinity, otherwise, false.
471
476
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
472
477
*/
473
478
@ Deprecated
@@ -477,15 +482,15 @@ public boolean IsInfinity() {
477
482
478
483
/**
479
484
* Returns whether this object is a not-a-number value.
480
- * @return True if this object is a not-a-number value; otherwise, false.
485
+ * @return true if this object is a not-a-number value, otherwise, false.
481
486
*/
482
487
public boolean IsNaN () {
483
488
return this .getEr ().IsNaN ();
484
489
}
485
490
486
491
/**
487
492
* Returns whether this object is negative infinity.
488
- * @return True if this object is negative infinity; otherwise, false.
493
+ * @return true if this object is negative infinity, otherwise, false.
489
494
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
490
495
*/
491
496
@ Deprecated
@@ -495,7 +500,7 @@ public boolean IsNegativeInfinity() {
495
500
496
501
/**
497
502
* Returns whether this object is positive infinity.
498
- * @return True if this object is positive infinity; otherwise, false.
503
+ * @return true if this object is positive infinity, otherwise, false.
499
504
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
500
505
*/
501
506
@ Deprecated
@@ -505,7 +510,7 @@ public boolean IsPositiveInfinity() {
505
510
506
511
/**
507
512
* Returns whether this object is a quiet not-a-number value.
508
- * @return True if this object is a quiet not-a-number value; otherwise, false.
513
+ * @return true if this object is a quiet not-a-number value; otherwise, false.
509
514
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
510
515
*/
511
516
@ Deprecated
@@ -517,7 +522,7 @@ public boolean IsQuietNaN() {
517
522
* Returns whether this object is a signaling not-a-number value (which causes
518
523
* an error if the value is passed to any arithmetic operation in this
519
524
* class).
520
- * @return True if this object is a signaling not-a-number value (which causes
525
+ * @return true if this object is a signaling not-a-number value (which causes
521
526
* an error if the value is passed to any arithmetic operation in this
522
527
* class); otherwise, false.
523
528
* @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
0 commit comments