From 71a38079a348543fba49d7835f99c437cdc2d4d4 Mon Sep 17 00:00:00 2001 From: Trevor Spiteri Date: Fri, 16 Aug 2019 23:01:27 +0200 Subject: [PATCH] use 6 significant digits in docs for constants --- src/consts.rs | 54 +++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/src/consts.rs b/src/consts.rs index bd5dcd9..15c2fb3 100644 --- a/src/consts.rs +++ b/src/consts.rs @@ -35,189 +35,189 @@ use crate::{ }; use core::marker::PhantomData; -/// τ = 6.283… +/// τ = 6.28318… // TAU = 6.283185307179586476925286766559005768394... pub const TAU: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// τ/2 = 3.141… +/// τ/2 = 3.14159… // FRAC_TAU_2 = 3.141592653589793238462643383279502884197... pub const FRAC_TAU_2: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// τ/3 = 2.094… +/// τ/3 = 2.09439… // FRAC_TAU_3 = 2.094395102393195492308428922186335256131... pub const FRAC_TAU_3: FixedU128 = FixedU128 { bits: 0x860A_91C1_6B9B_2C23_2DD9_9707_AB3D_688B, phantom: PhantomData, }; -/// τ/4 = 1.570… +/// τ/4 = 1.57079… // FRAC_TAU_4 = 1.570796326794896619231321691639751442098... pub const FRAC_TAU_4: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// τ/6 = 1.047… +/// τ/6 = 1.04719… // FRAC_TAU_6 = 1.047197551196597746154214461093167628065... pub const FRAC_TAU_6: FixedU128 = FixedU128 { bits: 0x860A_91C1_6B9B_2C23_2DD9_9707_AB3D_688B, phantom: PhantomData, }; -/// τ/8 = 0.7853… +/// τ/8 = 0.785398… // FRAC_TAU_8 = 0.7853981633974483096156608458198757210492... pub const FRAC_TAU_8: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// 1/τ = 0.1591… +/// 1/τ = 0.159154… // FRAC_1_TAU = 0.1591549430918953357688837633725143620344... pub const FRAC_1_TAU: FixedU128 = FixedU128 { bits: 0x28BE_60DB_9391_054A_7F09_D5F4_7D4D_3770, phantom: PhantomData, }; -/// 2/τ = 0.3183… +/// 2/τ = 0.318309… // FRAC_2_TAU = 0.3183098861837906715377675267450287240689... pub const FRAC_2_TAU: FixedU128 = FixedU128 { bits: 0x517C_C1B7_2722_0A94_FE13_ABE8_FA9A_6EE0, phantom: PhantomData, }; -/// 4/τ = 0.6366… +/// 4/τ = 0.636619… // FRAC_4_TAU = 0.6366197723675813430755350534900574481378... pub const FRAC_4_TAU: FixedU128 = FixedU128 { bits: 0xA2F9_836E_4E44_1529_FC27_57D1_F534_DDC0, phantom: PhantomData, }; -/// π = 3.141… +/// π = 3.14159… // PI = 3.141592653589793238462643383279502884197... pub const PI: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// π/2 = 1.570… +/// π/2 = 1.57079… // FRAC_PI_2 = 1.570796326794896619231321691639751442098... pub const FRAC_PI_2: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// π/3 = 1.047… +/// π/3 = 1.04719… // FRAC_PI_3 = 1.047197551196597746154214461093167628065... pub const FRAC_PI_3: FixedU128 = FixedU128 { bits: 0x860A_91C1_6B9B_2C23_2DD9_9707_AB3D_688B, phantom: PhantomData, }; -/// π/4 = 0.7853… +/// π/4 = 0.785398… // FRAC_PI_4 = 0.7853981633974483096156608458198757210492... pub const FRAC_PI_4: FixedU128 = FixedU128 { bits: 0xC90F_DAA2_2168_C234_C4C6_628B_80DC_1CD1, phantom: PhantomData, }; -/// π/6 = 0.5235… +/// π/6 = 0.523598… // FRAC_PI_6 = 0.5235987755982988730771072305465838140328... pub const FRAC_PI_6: FixedU128 = FixedU128 { bits: 0x860A_91C1_6B9B_2C23_2DD9_9707_AB3D_688B, phantom: PhantomData, }; -/// π/8 = 0.3926… +/// π/8 = 0.392699… // FRAC_PI_8 = 0.3926990816987241548078304229099378605246... pub const FRAC_PI_8: FixedU128 = FixedU128 { bits: 0x6487_ED51_10B4_611A_6263_3145_C06E_0E68, phantom: PhantomData, }; -/// 1/π = 0.3183… +/// 1/π = 0.318309… // FRAC_1_PI = 0.3183098861837906715377675267450287240689... pub const FRAC_1_PI: FixedU128 = FixedU128 { bits: 0x517C_C1B7_2722_0A94_FE13_ABE8_FA9A_6EE0, phantom: PhantomData, }; -/// 2/π = 0.6366… +/// 2/π = 0.636619… // FRAC_2_PI = 0.6366197723675813430755350534900574481378... pub const FRAC_2_PI: FixedU128 = FixedU128 { bits: 0xA2F9_836E_4E44_1529_FC27_57D1_F534_DDC0, phantom: PhantomData, }; -/// 2/√π = 1.128… +/// 2/√π = 1.12837… // FRAC_2_SQRT_PI = 1.128379167095512573896158903121545171688... pub const FRAC_2_SQRT_PI: FixedU128 = FixedU128 { bits: 0x906E_BA82_14DB_688D_71D4_8A7F_6BFE_C344, phantom: PhantomData, }; -/// √2 = 1.414… +/// √2 = 1.41421… // SQRT_2 = 1.414213562373095048801688724209698078569... pub const SQRT_2: FixedU128 = FixedU128 { bits: 0xB504_F333_F9DE_6484_597D_89B3_754A_BE9F, phantom: PhantomData, }; -/// 1/√2 = 0.7071… +/// 1/√2 = 0.707106… // FRAC_1_SQRT_2 = 0.7071067811865475244008443621048490392848... pub const FRAC_1_SQRT_2: FixedU128 = FixedU128 { bits: 0xB504_F333_F9DE_6484_597D_89B3_754A_BE9F, phantom: PhantomData, }; -/// e = 2.718… +/// e = 2.71828… // E = 2.718281828459045235360287471352662497757... pub const E: FixedU128 = FixedU128 { bits: 0xADF8_5458_A2BB_4A9A_AFDC_5620_273D_3CF1, phantom: PhantomData, }; -/// log2 10 = 3.321… +/// log2 10 = 3.32192… // LOG2_10 = 3.321928094887362347870319429489390175864... pub const LOG2_10: FixedU128 = FixedU128 { bits: 0xD49A_784B_CD1B_8AFE_492B_F6FF_4DAF_DB4C, phantom: PhantomData, }; -/// log2 e = 1.442… +/// log2 e = 1.44269… // LOG2_E = 1.442695040888963407359924681001892137426... pub const LOG2_E: FixedU128 = FixedU128 { bits: 0xB8AA_3B29_5C17_F0BB_BE87_FED0_691D_3E88, phantom: PhantomData, }; -/// log10 2 = 0.3010… +/// log10 2 = 0.301029… // LOG10_2 = 0.3010299956639811952137388947244930267681... pub const LOG10_2: FixedU128 = FixedU128 { bits: 0x4D10_4D42_7DE7_FBCC_47C4_ACD6_05BE_48BC, phantom: PhantomData, }; -/// log10 e = 0.4342… +/// log10 e = 0.434294… // LOG10_E = 0.4342944819032518276511289189166050822943... pub const LOG10_E: FixedU128 = FixedU128 { bits: 0x6F2D_EC54_9B94_38CA_9AAD_D557_D699_EE19, phantom: PhantomData, }; -/// ln 2 = 0.6931… +/// ln 2 = 0.693147… // LN_2 = 0.6931471805599453094172321214581765680755... pub const LN_2: FixedU128 = FixedU128 { bits: 0xB172_17F7_D1CF_79AB_C9E3_B398_03F2_F6AF, phantom: PhantomData, }; -/// ln 10 = 2.302… +/// ln 10 = 2.30258… // LN_10 = 2.302585092994045684017991454684364207601... pub const LN_10: FixedU128 = FixedU128 { bits: 0x935D_8DDD_AAA8_AC16_EA56_D62B_82D3_0A28,