1
Fork 0

Change lint name to suboptimal_flops

This commit is contained in:
Krishna Sai Veera Reddy 2020-02-17 12:56:55 -08:00
parent bc03f465c3
commit 6dacb1aa67
10 changed files with 45 additions and 41 deletions

View file

@ -1349,6 +1349,7 @@ Released 2018-09-13
[`string_lit_as_bytes`]: https://rust-lang.github.io/rust-clippy/master/index.html#string_lit_as_bytes [`string_lit_as_bytes`]: https://rust-lang.github.io/rust-clippy/master/index.html#string_lit_as_bytes
[`string_to_string`]: https://rust-lang.github.io/rust-clippy/master/index.html#string_to_string [`string_to_string`]: https://rust-lang.github.io/rust-clippy/master/index.html#string_to_string
[`struct_excessive_bools`]: https://rust-lang.github.io/rust-clippy/master/index.html#struct_excessive_bools [`struct_excessive_bools`]: https://rust-lang.github.io/rust-clippy/master/index.html#struct_excessive_bools
[`suboptimal_flops`]: https://rust-lang.github.io/rust-clippy/master/index.html#suboptimal_flops
[`suspicious_arithmetic_impl`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_arithmetic_impl [`suspicious_arithmetic_impl`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_arithmetic_impl
[`suspicious_assignment_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_assignment_formatting [`suspicious_assignment_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_assignment_formatting
[`suspicious_else_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_else_formatting [`suspicious_else_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_else_formatting

View file

@ -4,10 +4,10 @@ use crate::consts::{
}; };
use crate::utils::*; use crate::utils::*;
use if_chain::if_chain; use if_chain::if_chain;
use rustc_hir::*;
use rustc_lint::{LateContext, LateLintPass};
use rustc::ty; use rustc::ty;
use rustc_errors::Applicability; use rustc_errors::Applicability;
use rustc_hir::*;
use rustc_lint::{LateContext, LateLintPass};
use rustc_session::{declare_lint_pass, declare_tool_lint}; use rustc_session::{declare_lint_pass, declare_tool_lint};
use std::f32::consts as f32_consts; use std::f32::consts as f32_consts;
use std::f64::consts as f64_consts; use std::f64::consts as f64_consts;
@ -16,11 +16,10 @@ use syntax::ast;
declare_clippy_lint! { declare_clippy_lint! {
/// **What it does:** Looks for floating-point expressions that /// **What it does:** Looks for floating-point expressions that
/// can be expressed using built-in methods to improve accuracy, /// can be expressed using built-in methods to improve both
/// performance and/or succinctness. /// accuracy and performance.
/// ///
/// **Why is this bad?** Negatively affects accuracy, performance /// **Why is this bad?** Negatively impacts accuracy and performance.
/// and/or readability.
/// ///
/// **Known problems:** None /// **Known problems:** None
/// ///
@ -59,16 +58,16 @@ declare_clippy_lint! {
/// let _ = a.exp_m1(); /// let _ = a.exp_m1();
/// let _ = a.powi(2); /// let _ = a.powi(2);
/// ``` /// ```
pub FLOATING_POINT_IMPROVEMENTS, pub SUBOPTIMAL_FLOPS,
nursery, nursery,
"looks for improvements to floating-point expressions" "usage of sub-optimal floating point operations"
} }
declare_lint_pass!(FloatingPointArithmetic => [FLOATING_POINT_IMPROVEMENTS]); declare_lint_pass!(FloatingPointArithmetic => [SUBOPTIMAL_FLOPS]);
// Returns the specialized log method for a given base if base is constant // Returns the specialized log method for a given base if base is constant
// and is one of 2, 10 and e // and is one of 2, 10 and e
fn get_specialized_log_method(cx: &LateContext<'_, '_>, base: &Expr) -> Option<&'static str> { fn get_specialized_log_method(cx: &LateContext<'_, '_>, base: &Expr<'_>) -> Option<&'static str> {
if let Some((value, _)) = constant(cx, cx.tables, base) { if let Some((value, _)) = constant(cx, cx.tables, base) {
if F32(2.0) == value || F64(2.0) == value { if F32(2.0) == value || F64(2.0) == value {
return Some("log2"); return Some("log2");
@ -124,7 +123,7 @@ fn check_log_base(cx: &LateContext<'_, '_>, expr: &Expr<'_>, args: &[Expr<'_>])
if let Some(method) = get_specialized_log_method(cx, &args[1]) { if let Some(method) = get_specialized_log_method(cx, &args[1]) {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
"logarithm for bases 2, 10 and e can be computed more accurately", "logarithm for bases 2, 10 and e can be computed more accurately",
"consider using", "consider using",
@ -136,7 +135,7 @@ fn check_log_base(cx: &LateContext<'_, '_>, expr: &Expr<'_>, args: &[Expr<'_>])
// TODO: Lint expressions of the form `(x + y).ln()` where y > 1 and // TODO: Lint expressions of the form `(x + y).ln()` where y > 1 and
// suggest usage of `(x + (y - 1)).ln_1p()` instead // suggest usage of `(x + (y - 1)).ln_1p()` instead
fn check_ln1p(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) { fn check_ln1p(cx: &LateContext<'_, '_>, expr: &Expr<'_>, args: &[Expr<'_>]) {
if_chain! { if_chain! {
if let ExprKind::Binary(op, ref lhs, ref rhs) = &args[0].kind; if let ExprKind::Binary(op, ref lhs, ref rhs) = &args[0].kind;
if op.node == BinOpKind::Add; if op.node == BinOpKind::Add;
@ -149,7 +148,7 @@ fn check_ln1p(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
"ln(1 + x) can be computed more accurately", "ln(1 + x) can be computed more accurately",
"consider using", "consider using",
@ -185,7 +184,7 @@ fn get_integer_from_float_constant(value: &Constant) -> Option<i64> {
} }
} }
fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) { fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr<'_>, args: &[Expr<'_>]) {
// Check receiver // Check receiver
if let Some((value, _)) = constant(cx, cx.tables, &args[0]) { if let Some((value, _)) = constant(cx, cx.tables, &args[0]) {
let method; let method;
@ -200,7 +199,7 @@ fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
"exponent for bases 2 and e can be computed more accurately", "exponent for bases 2 and e can be computed more accurately",
"consider using", "consider using",
@ -223,7 +222,7 @@ fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) {
} else if let Some(exponent) = get_integer_from_float_constant(&value) { } else if let Some(exponent) = get_integer_from_float_constant(&value) {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
"exponentiation with integer powers can be computed more efficiently", "exponentiation with integer powers can be computed more efficiently",
"consider using", "consider using",
@ -238,7 +237,7 @@ fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
help, help,
"consider using", "consider using",
@ -250,7 +249,7 @@ fn check_powf(cx: &LateContext<'_, '_>, expr: &Expr, args: &HirVec<Expr>) {
// TODO: Lint expressions of the form `x.exp() - y` where y > 1 // TODO: Lint expressions of the form `x.exp() - y` where y > 1
// and suggest usage of `x.exp_m1() - (y - 1)` instead // and suggest usage of `x.exp_m1() - (y - 1)` instead
fn check_expm1(cx: &LateContext<'_, '_>, expr: &Expr) { fn check_expm1(cx: &LateContext<'_, '_>, expr: &Expr<'_>) {
if_chain! { if_chain! {
if let ExprKind::Binary(op, ref lhs, ref rhs) = expr.kind; if let ExprKind::Binary(op, ref lhs, ref rhs) = expr.kind;
if op.node == BinOpKind::Sub; if op.node == BinOpKind::Sub;
@ -263,7 +262,7 @@ fn check_expm1(cx: &LateContext<'_, '_>, expr: &Expr) {
then { then {
span_lint_and_sugg( span_lint_and_sugg(
cx, cx,
FLOATING_POINT_IMPROVEMENTS, SUBOPTIMAL_FLOPS,
expr.span, expr.span,
"(e.pow(x) - 1) can be computed more accurately", "(e.pow(x) - 1) can be computed more accurately",
"consider using", "consider using",
@ -278,7 +277,7 @@ fn check_expm1(cx: &LateContext<'_, '_>, expr: &Expr) {
} }
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for FloatingPointArithmetic { impl<'a, 'tcx> LateLintPass<'a, 'tcx> for FloatingPointArithmetic {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) { fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
if let ExprKind::MethodCall(ref path, _, args) = &expr.kind { if let ExprKind::MethodCall(ref path, _, args) = &expr.kind {
let recv_ty = cx.tables.expr_ty(&args[0]); let recv_ty = cx.tables.expr_ty(&args[0]);

View file

@ -538,6 +538,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
&fallible_impl_from::FALLIBLE_IMPL_FROM, &fallible_impl_from::FALLIBLE_IMPL_FROM,
&float_literal::EXCESSIVE_PRECISION, &float_literal::EXCESSIVE_PRECISION,
&float_literal::LOSSY_FLOAT_LITERAL, &float_literal::LOSSY_FLOAT_LITERAL,
&floating_point_arithmetic::SUBOPTIMAL_FLOPS,
&format::USELESS_FORMAT, &format::USELESS_FORMAT,
&formatting::POSSIBLE_MISSING_COMMA, &formatting::POSSIBLE_MISSING_COMMA,
&formatting::SUSPICIOUS_ASSIGNMENT_FORMATTING, &formatting::SUSPICIOUS_ASSIGNMENT_FORMATTING,
@ -1649,7 +1650,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
store.register_group(true, "clippy::nursery", Some("clippy_nursery"), vec![ store.register_group(true, "clippy::nursery", Some("clippy_nursery"), vec![
LintId::of(&attrs::EMPTY_LINE_AFTER_OUTER_ATTR), LintId::of(&attrs::EMPTY_LINE_AFTER_OUTER_ATTR),
LintId::of(&fallible_impl_from::FALLIBLE_IMPL_FROM), LintId::of(&fallible_impl_from::FALLIBLE_IMPL_FROM),
LintId::of(&floating_point_arithmetic::FLOATING_POINT_IMPROVEMENTS), LintId::of(&floating_point_arithmetic::SUBOPTIMAL_FLOPS),
LintId::of(&missing_const_for_fn::MISSING_CONST_FOR_FN), LintId::of(&missing_const_for_fn::MISSING_CONST_FOR_FN),
LintId::of(&mul_add::MANUAL_MUL_ADD), LintId::of(&mul_add::MANUAL_MUL_ADD),
LintId::of(&mutable_debug_assertion::DEBUG_ASSERT_WITH_MUT_CALL), LintId::of(&mutable_debug_assertion::DEBUG_ASSERT_WITH_MUT_CALL),

View file

@ -1960,6 +1960,13 @@ pub const ALL_LINTS: [Lint; 357] = [
deprecation: None, deprecation: None,
module: "excessive_bools", module: "excessive_bools",
}, },
Lint {
name: "suboptimal_flops",
group: "nursery",
desc: "usage of sub-optimal floating point operations",
deprecation: None,
module: "floating_point_arithmetic",
},
Lint { Lint {
name: "suspicious_arithmetic_impl", name: "suspicious_arithmetic_impl",
group: "correctness", group: "correctness",

View file

@ -1,4 +1,4 @@
#![warn(clippy::floating_point_improvements)] #![warn(clippy::suboptimal_flops)]
fn main() { fn main() {
let x = 2f32; let x = 2f32;

View file

@ -4,7 +4,7 @@ error: (e.pow(x) - 1) can be computed more accurately
LL | let _ = x.exp() - 1.0; LL | let _ = x.exp() - 1.0;
| ^^^^^^^^^^^^^ help: consider using: `x.exp_m1()` | ^^^^^^^^^^^^^ help: consider using: `x.exp_m1()`
| |
= note: `-D clippy::floating-point-improvements` implied by `-D warnings` = note: `-D clippy::suboptimal-flops` implied by `-D warnings`
error: (e.pow(x) - 1) can be computed more accurately error: (e.pow(x) - 1) can be computed more accurately
--> $DIR/floating_point_exp.rs:6:13 --> $DIR/floating_point_exp.rs:6:13

View file

@ -1,5 +1,5 @@
#![allow(dead_code)] #![allow(dead_code)]
#![warn(clippy::floating_point_improvements)] #![warn(clippy::suboptimal_flops)]
const TWO: f32 = 2.0; const TWO: f32 = 2.0;
const E: f32 = std::f32::consts::E; const E: f32 = std::f32::consts::E;

View file

@ -4,7 +4,7 @@ error: logarithm for bases 2, 10 and e can be computed more accurately
LL | let _ = x.log(2f32); LL | let _ = x.log(2f32);
| ^^^^^^^^^^^ help: consider using: `x.log2()` | ^^^^^^^^^^^ help: consider using: `x.log2()`
| |
= note: `-D clippy::floating-point-improvements` implied by `-D warnings` = note: `-D clippy::suboptimal-flops` implied by `-D warnings`
error: logarithm for bases 2, 10 and e can be computed more accurately error: logarithm for bases 2, 10 and e can be computed more accurately
--> $DIR/floating_point_log.rs:10:13 --> $DIR/floating_point_log.rs:10:13

View file

@ -1,4 +1,4 @@
#![warn(clippy::floating_point_improvements)] #![warn(clippy::suboptimal_flops)]
fn main() { fn main() {
let x = 3f32; let x = 3f32;
@ -14,8 +14,6 @@ fn main() {
let _ = x.powf(-2.0); let _ = x.powf(-2.0);
let _ = x.powf(2.1); let _ = x.powf(2.1);
let _ = x.powf(-2.1); let _ = x.powf(-2.1);
let _ = x.powf(16_777_217.0);
let _ = x.powf(-16_777_217.0);
let x = 3f64; let x = 3f64;
let _ = 2f64.powf(x); let _ = 2f64.powf(x);
@ -30,6 +28,4 @@ fn main() {
let _ = x.powf(-2.0); let _ = x.powf(-2.0);
let _ = x.powf(2.1); let _ = x.powf(2.1);
let _ = x.powf(-2.1); let _ = x.powf(-2.1);
let _ = x.powf(9_007_199_254_740_993.0);
let _ = x.powf(-9_007_199_254_740_993.0);
} }

View file

@ -4,7 +4,7 @@ error: exponent for bases 2 and e can be computed more accurately
LL | let _ = 2f32.powf(x); LL | let _ = 2f32.powf(x);
| ^^^^^^^^^^^^ help: consider using: `x.exp2()` | ^^^^^^^^^^^^ help: consider using: `x.exp2()`
| |
= note: `-D clippy::floating-point-improvements` implied by `-D warnings` = note: `-D clippy::suboptimal-flops` implied by `-D warnings`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:6:13 --> $DIR/floating_point_powf.rs:6:13
@ -61,61 +61,61 @@ LL | let _ = x.powf(-2.0);
| ^^^^^^^^^^^^ help: consider using: `x.powi(-2)` | ^^^^^^^^^^^^ help: consider using: `x.powi(-2)`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:21:13 --> $DIR/floating_point_powf.rs:19:13
| |
LL | let _ = 2f64.powf(x); LL | let _ = 2f64.powf(x);
| ^^^^^^^^^^^^ help: consider using: `x.exp2()` | ^^^^^^^^^^^^ help: consider using: `x.exp2()`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:22:13 --> $DIR/floating_point_powf.rs:20:13
| |
LL | let _ = 2f64.powf(3.1); LL | let _ = 2f64.powf(3.1);
| ^^^^^^^^^^^^^^ help: consider using: `3.1f64.exp2()` | ^^^^^^^^^^^^^^ help: consider using: `3.1f64.exp2()`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:23:13 --> $DIR/floating_point_powf.rs:21:13
| |
LL | let _ = 2f64.powf(-3.1); LL | let _ = 2f64.powf(-3.1);
| ^^^^^^^^^^^^^^^ help: consider using: `(-3.1f64).exp2()` | ^^^^^^^^^^^^^^^ help: consider using: `(-3.1f64).exp2()`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:24:13 --> $DIR/floating_point_powf.rs:22:13
| |
LL | let _ = std::f64::consts::E.powf(x); LL | let _ = std::f64::consts::E.powf(x);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `x.exp()` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `x.exp()`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:25:13 --> $DIR/floating_point_powf.rs:23:13
| |
LL | let _ = std::f64::consts::E.powf(3.1); LL | let _ = std::f64::consts::E.powf(3.1);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `3.1f64.exp()` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `3.1f64.exp()`
error: exponent for bases 2 and e can be computed more accurately error: exponent for bases 2 and e can be computed more accurately
--> $DIR/floating_point_powf.rs:26:13 --> $DIR/floating_point_powf.rs:24:13
| |
LL | let _ = std::f64::consts::E.powf(-3.1); LL | let _ = std::f64::consts::E.powf(-3.1);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `(-3.1f64).exp()` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `(-3.1f64).exp()`
error: square-root of a number can be computed more efficiently and accurately error: square-root of a number can be computed more efficiently and accurately
--> $DIR/floating_point_powf.rs:27:13 --> $DIR/floating_point_powf.rs:25:13
| |
LL | let _ = x.powf(1.0 / 2.0); LL | let _ = x.powf(1.0 / 2.0);
| ^^^^^^^^^^^^^^^^^ help: consider using: `x.sqrt()` | ^^^^^^^^^^^^^^^^^ help: consider using: `x.sqrt()`
error: cube-root of a number can be computed more accurately error: cube-root of a number can be computed more accurately
--> $DIR/floating_point_powf.rs:28:13 --> $DIR/floating_point_powf.rs:26:13
| |
LL | let _ = x.powf(1.0 / 3.0); LL | let _ = x.powf(1.0 / 3.0);
| ^^^^^^^^^^^^^^^^^ help: consider using: `x.cbrt()` | ^^^^^^^^^^^^^^^^^ help: consider using: `x.cbrt()`
error: exponentiation with integer powers can be computed more efficiently error: exponentiation with integer powers can be computed more efficiently
--> $DIR/floating_point_powf.rs:29:13 --> $DIR/floating_point_powf.rs:27:13
| |
LL | let _ = x.powf(2.0); LL | let _ = x.powf(2.0);
| ^^^^^^^^^^^ help: consider using: `x.powi(2)` | ^^^^^^^^^^^ help: consider using: `x.powi(2)`
error: exponentiation with integer powers can be computed more efficiently error: exponentiation with integer powers can be computed more efficiently
--> $DIR/floating_point_powf.rs:30:13 --> $DIR/floating_point_powf.rs:28:13
| |
LL | let _ = x.powf(-2.0); LL | let _ = x.powf(-2.0);
| ^^^^^^^^^^^^ help: consider using: `x.powi(-2)` | ^^^^^^^^^^^^ help: consider using: `x.powi(-2)`