├── .travis.yml ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README-crates.io.md ├── README.rst ├── examples └── sums.rs └── src └── lib.rs /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | sudo: false 3 | matrix: 4 | include: 5 | - rust: nightly 6 | branches: 7 | only: 8 | - master 9 | script: 10 | - | 11 | cargo build -v && 12 | cargo test -v 13 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | version = "0.2.0" 3 | 4 | name = "fast-floats" 5 | license = "MIT OR Apache-2.0" 6 | authors = ["bluss"] 7 | edition = "2021" 8 | 9 | repository = "https://github.com/bluss/fast-floats" 10 | documentation = "https://docs.rs/fast-floats/" 11 | 12 | readme = "README-crates.io.md" 13 | description = "Fast-math wrappers for floats; experimental and unstable; for experiments." 14 | 15 | keywords = [] 16 | categories = [] 17 | 18 | [dependencies] 19 | 20 | [features] 21 | 22 | [package.metadata.docs.rs] 23 | features = [] 24 | 25 | [package.metadata.release] 26 | no-dev-version = true 27 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2017 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README-crates.io.md: -------------------------------------------------------------------------------- 1 | Experimental (unstable) “fast-math” wrappers for f32, f64 2 | 3 | These wrappers enable the [“fast-math”][1] flags for the operations 4 | where there are intrinsics for this (add, sub, mul, div, rem). 5 | The wrappers exist so that we have a quick & easy way to experiment 6 | with fast math flags and further that feature in Rust. 7 | 8 | Note that as of this writing, the Rust instrinsics use the “fast” flag 9 | documented in the langref; this enables all the float flags. 10 | 11 | [1]: https://llvm.org/docs/LangRef.html#fast-math-flags 12 | 13 | # Rust Version 14 | 15 | This crate is nightly only and experimental. Breaking changes can occur at 16 | any time, if changes in Rust require it. 17 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | fast-floats 2 | =========== 3 | 4 | Please read the `API documentation on docs.rs`__ 5 | 6 | __ https://docs.rs/fast-floats/ 7 | 8 | |build_status|_ |crates|_ 9 | 10 | .. |build_status| image:: https://travis-ci.org/bluss/fast-floats.svg?branch=master 11 | .. _build_status: https://travis-ci.org/bluss/fast-floats 12 | 13 | .. |crates| image:: https://img.shields.io/crates/v/fast-floats.svg 14 | .. _crates: https://crates.io/crates/fast-floats 15 | 16 | 17 | Recent Changes 18 | -------------- 19 | 20 | - 0.2.0 21 | 22 | - ``Fast`` now requires ``unsafe`` to create values: to be clear that it is a 23 | soundness issue to have problematic values in ``Fast``, i.e. non-finite 24 | floats. No safe constructors also means that ``Default`` and ``Zero`` traits disappear. 25 | - Fix bug in assign ops: they were previously implemented incorrectly (Except +=) 26 | 27 | - 0.1.2 28 | 29 | - Use repr(transparent) on Fast 30 | - Add type aliases FF64, FF32 and a few trait impls 31 | 32 | - 0.1.1 33 | 34 | - Add mixed operations (Fast + f64 etc.) 35 | 36 | - 0.1.0 37 | 38 | - Initial release. 39 | 40 | 41 | License 42 | ======= 43 | 44 | Dual-licensed to be compatible with the Rust project. 45 | 46 | Licensed under the Apache License, Version 2.0 47 | https://www.apache.org/licenses/LICENSE-2.0 or the MIT license 48 | https://opensource.org/licenses/MIT, at your 49 | option. This file may not be copied, modified, or distributed 50 | except according to those terms. 51 | 52 | 53 | -------------------------------------------------------------------------------- /examples/sums.rs: -------------------------------------------------------------------------------- 1 | extern crate fast_floats; 2 | 3 | use fast_floats::Fast; 4 | 5 | // for demonstration purposes 6 | pub unsafe fn fast_sum(xs: &[f64]) -> f64 { 7 | xs.iter().map(|&x| Fast::new(x)).fold(Fast::new(0.), |acc, x| acc + x).get() 8 | } 9 | 10 | // for demonstration purposes 11 | pub unsafe fn fast_dot(xs: &[f64], ys: &[f64]) -> f64 { 12 | xs.iter().zip(ys).fold(Fast::new(0.), |acc, (&x, &y)| acc + Fast::new(x) * Fast::new(y)).get() 13 | } 14 | 15 | pub fn regular_sum(xs: &[f64]) -> f64 { 16 | xs.iter().map(|&x| x).fold(0., |acc, x| acc + x) 17 | } 18 | 19 | fn main() { 20 | } 21 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Experimental (unstable) “fast-math” wrappers for f32, f64 2 | //! 3 | //! These wrappers enable the [“fast-math”][1] flags for the operations 4 | //! where there are intrinsics for this (add, sub, mul, div, rem). 5 | //! The wrappers exist so that we have a quick & easy way **to experiment** 6 | //! with fast math flags and further that feature in Rust. 7 | //! 8 | //! Note that as of this writing, the Rust instrinsics use the “fast” flag 9 | //! documented in the langref; this enables all the float flags. 10 | //! 11 | //! [1]: https://llvm.org/docs/LangRef.html#fast-math-flags 12 | //! 13 | //! # Rust Version 14 | //! 15 | //! This crate is nightly only and experimental. Breaking changes can occur at 16 | //! any time, if changes in Rust require it. 17 | #![no_std] 18 | #![feature(core_intrinsics)] 19 | 20 | extern crate core as std; 21 | 22 | use std::intrinsics::{fadd_fast, fsub_fast, fmul_fast, fdiv_fast, frem_fast}; 23 | use std::ops::{ 24 | Add, 25 | Sub, 26 | Mul, 27 | Div, 28 | Rem, 29 | AddAssign, 30 | SubAssign, 31 | MulAssign, 32 | DivAssign, 33 | RemAssign, 34 | }; 35 | 36 | /// “fast-math” wrapper for f32 and f64. 37 | /// 38 | /// The `Fast` type enforces no invariant and can hold any f32, f64 values. 39 | /// See crate docs for more details. 40 | #[derive(Copy, Clone, PartialEq, PartialOrd)] 41 | #[repr(transparent)] 42 | pub struct Fast(F); 43 | 44 | /// “fast-math” wrapper for `f64` 45 | pub type FF64 = Fast; 46 | /// “fast-math” wrapper for `f32` 47 | pub type FF32 = Fast; 48 | 49 | impl Fast { 50 | /// Create a new fast value 51 | /// 52 | /// # Safety 53 | /// 54 | /// The value can be used with the `fast_fadd` etc intrinsics without checks after it has been 55 | /// created like this. Refer to Rust and other sources for documentation on which operations 56 | /// are valid (might change with time). 57 | /// 58 | /// Be wary of operations creating invalid values in `Fast` which they could potentially do 59 | /// depending on the operation. 60 | pub unsafe fn new(value: F) -> Self { Fast(value) } 61 | 62 | /// Get the inner value 63 | pub fn get(self) -> F { self.0 } 64 | } 65 | 66 | impl Into for Fast { 67 | fn into(self: Self) -> f32 { self.get() } 68 | } 69 | 70 | impl Into for Fast { 71 | fn into(self: Self) -> f64 { self.get() } 72 | } 73 | 74 | macro_rules! impl_op { 75 | ($($name:ident, $method:ident, $intrins:ident;)*) => { 76 | $( 77 | // Fast + F 78 | impl $name for Fast { 79 | type Output = Self; 80 | #[inline(always)] 81 | fn $method(self, rhs: f64) -> Self::Output { 82 | unsafe { 83 | Fast($intrins(self.0, rhs)) 84 | } 85 | } 86 | } 87 | 88 | impl $name for Fast { 89 | type Output = Self; 90 | #[inline(always)] 91 | fn $method(self, rhs: f32) -> Self::Output { 92 | unsafe { 93 | Fast($intrins(self.0, rhs)) 94 | } 95 | } 96 | } 97 | 98 | // F + Fast 99 | impl $name> for f64 { 100 | type Output = Fast; 101 | #[inline(always)] 102 | fn $method(self, rhs: Fast) -> Self::Output { 103 | Fast(self).$method(rhs.0) 104 | } 105 | } 106 | 107 | impl $name> for f32 { 108 | type Output = Fast; 109 | #[inline(always)] 110 | fn $method(self, rhs: Fast) -> Self::Output { 111 | Fast(self).$method(rhs.0) 112 | } 113 | } 114 | 115 | // Fast + Fast 116 | impl $name for Fast { 117 | type Output = Self; 118 | #[inline(always)] 119 | fn $method(self, rhs: Self) -> Self::Output { 120 | self.$method(rhs.0) 121 | } 122 | } 123 | 124 | impl $name for Fast { 125 | type Output = Self; 126 | #[inline(always)] 127 | fn $method(self, rhs: Self) -> Self::Output { 128 | self.$method(rhs.0) 129 | } 130 | } 131 | )* 132 | 133 | } 134 | } 135 | 136 | macro_rules! impl_assignop { 137 | ($($name:ident, $method:ident, $optrt:ident, $opmth:ident;)*) => { 138 | $( 139 | impl $name for Fast 140 | where Self: $optrt + Copy, 141 | { 142 | #[inline(always)] 143 | fn $method(&mut self, rhs: Rhs) { 144 | *self = (*self).$opmth(rhs) 145 | } 146 | } 147 | )* 148 | 149 | } 150 | } 151 | 152 | impl_op! { 153 | Add, add, fadd_fast; 154 | Sub, sub, fsub_fast; 155 | Mul, mul, fmul_fast; 156 | Div, div, fdiv_fast; 157 | Rem, rem, frem_fast; 158 | } 159 | 160 | impl_assignop! { 161 | AddAssign, add_assign, Add, add; 162 | SubAssign, sub_assign, Sub, sub; 163 | MulAssign, mul_assign, Mul, mul; 164 | DivAssign, div_assign, Div, div; 165 | RemAssign, rem_assign, Rem, rem; 166 | } 167 | 168 | use std::fmt; 169 | macro_rules! impl_format { 170 | ($($name:ident)+) => { 171 | $( 172 | impl fmt::$name for Fast { 173 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 174 | self.0.fmt(f) 175 | } 176 | } 177 | )+ 178 | } 179 | } 180 | 181 | impl_format!(Debug Display LowerExp UpperExp); 182 | 183 | 184 | #[cfg(test)] 185 | mod tests { 186 | use super::*; 187 | 188 | macro_rules! test_op { 189 | ($($op:tt)+) => { 190 | $( 191 | assert_eq!(Fast(2.) $op Fast(1.), Fast(2. $op 1.)); 192 | )+ 193 | } 194 | } 195 | 196 | #[test] 197 | fn each_op() { 198 | test_op!(+ - * / %); 199 | } 200 | 201 | macro_rules! assign_op { 202 | ($($x:literal $op:tt $y:literal is $z:literal ;)+) => { 203 | $( 204 | let mut x = Fast($x); 205 | x $op Fast($y); 206 | assert_eq!(x, Fast($z)); 207 | )+ 208 | } 209 | } 210 | 211 | #[test] 212 | fn assign_ops() { 213 | assign_op!( 214 | 1. += 2. is 3.; 215 | 1. -= 2. is -1.; 216 | 2. *= 2. is 4.; 217 | 2. /= 2. is 1.; 218 | 5. %= 2. is 1.; 219 | ); 220 | } 221 | } 222 | --------------------------------------------------------------------------------