Skip to content

Commit 0da1093

Browse files
committed
Rename the Carlson methods
1 parent 5110647 commit 0da1093

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

src/elliptic.rs

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -464,8 +464,6 @@ implement!(
464464
/// [1]: https://crates.io/crates/ellip
465465
@second_kc el3 -> el3(x, p),
466466

467-
// <--- Carlson's Symmetric Integrals --->
468-
469467
/// Compute Carlson's symmetric elliptic integral of the first kind (RF).
470468
///
471469
/// The implementation is based on [ellip][1] by Sira Pornsiriprasert.
@@ -483,15 +481,15 @@ implement!(
483481
/// let y = 0.5;
484482
/// let z = 0.25;
485483
///
486-
/// assert::close(x.elliprf(y, z), 1.370171633266872, 1e-15)
484+
/// assert::close(x.carlson_rf(y, z), 1.370171633266872, 1e-15)
487485
/// ```
488486
///
489487
/// ## Panics
490488
///
491489
/// The function panics if any of x, y, or z is negative, or more than one of them are zero.
492490
///
493491
/// [1]: https://crates.io/crates/ellip
494-
elliprf -> elliprf(y, z),
492+
carlson_rf -> elliprf(y, z),
495493

496494
/// Compute Carlson's symmetric elliptic integral of the second kind (RG).
497495
///
@@ -510,15 +508,15 @@ implement!(
510508
/// let y = 0.5;
511509
/// let z = 0.25;
512510
///
513-
/// assert::close(x.elliprg(y, z), 0.7526721491833781, 1e-15)
511+
/// assert::close(x.carlson_rg(y, z), 0.7526721491833781, 1e-15)
514512
/// ```
515513
///
516514
/// ## Panics
517515
///
518516
/// The function panics if any of x, y, or z is negative or infinite.
519517
///
520518
/// [1]: https://crates.io/crates/ellip
521-
elliprg -> elliprg(y, z),
519+
carlson_rg -> elliprg(y, z),
522520

523521
/// Compute Carlson's symmetric elliptic integral of the third kind (RJ).
524522
///
@@ -539,15 +537,15 @@ implement!(
539537
/// let z = 0.25;
540538
/// let p = 0.125;
541539
///
542-
/// assert::close(x.elliprj(y, z, p), 5.680557292035963, 1e-15)
540+
/// assert::close(x.carlson_rj(y, z, p), 5.680557292035963, 1e-15)
543541
/// ```
544542
///
545543
/// ## Panics
546544
///
547545
/// The function panics if p = 0, any of x, y, or z is negative, or more than one of them are zero.
548546
///
549547
/// [1]: https://crates.io/crates/ellip
550-
@first_m elliprj -> elliprj(y, z, p),
548+
@first_m carlson_rj -> elliprj(y, z, p),
551549

552550
/// Compute Carlson's degenerate symmetric elliptic integral (RC).
553551
///
@@ -565,15 +563,15 @@ implement!(
565563
/// let x = 1.0;
566564
/// let y = 0.5;
567565
///
568-
/// assert::close(x.elliprc(y), 1.2464504802804608, 1e-15)
566+
/// assert::close(x.carlson_rc(y), 1.2464504802804608, 1e-15)
569567
/// ```
570568
///
571569
/// ## Panics
572570
///
573571
/// The function panics if x < 0, y = 0, or y < 0.
574572
///
575573
/// [1]: https://crates.io/crates/ellip
576-
@first_m elliprc -> elliprc(y),
574+
@first_m carlson_rc -> elliprc(y),
577575

578576
/// Compute Carlson's symmetric elliptic integral of the second kind (RD).
579577
///
@@ -592,15 +590,15 @@ implement!(
592590
/// let y = 0.5;
593591
/// let z = 0.25;
594592
///
595-
/// assert::close(x.elliprd(y, z), 4.022594757168912, 1e-15)
593+
/// assert::close(x.carlson_rd(y, z), 4.022594757168912, 1e-15)
596594
/// ```
597595
///
598596
/// ## Panics
599597
///
600598
/// The function panics if x < 0, y < 0, z ≤ 0 or when both x and y are zero.
601599
///
602600
/// [1]: https://crates.io/crates/ellip
603-
@first_m elliprd -> elliprd(y, z),
601+
@first_m carlson_rd -> elliprd(y, z),
604602

605603
// <--- Miscellaneous Functions --->
606604

0 commit comments

Comments
 (0)