clang-tools  14.0.0git
IncorrectRoundingsCheck.h
Go to the documentation of this file.
1 //===--- IncorrectRoundingsCheck.h - clang-tidy -----------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INCORRECTROUNDINGSCHECK_H_
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INCORRECTROUNDINGSCHECK_H_
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// Checks the usage of patterns known to produce incorrect rounding.
19 /// Programmers often use
20 /// (int)(double_expression + 0.5)
21 /// to round the double expression to an integer. The problem with this
22 /// 1. It is unnecessarily slow.
23 /// 2. It is incorrect. The number 0.499999975 (smallest representable float
24 /// number below 0.5) rounds to 1.0. Even worse behavior for negative
25 /// numbers where both -0.5f and -1.4f both round to 0.0.
27 public:
29  : ClangTidyCheck(Name, Context) {}
30  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
31  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
32 };
33 
34 } // namespace bugprone
35 } // namespace tidy
36 } // namespace clang
37 
38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INCORRECTROUNDINGSCHECK_H_
clang::tidy::bugprone::IncorrectRoundingsCheck::IncorrectRoundingsCheck
IncorrectRoundingsCheck(StringRef Name, ClangTidyContext *Context)
Definition: IncorrectRoundingsCheck.h:28
clang::tidy::bugprone::IncorrectRoundingsCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: IncorrectRoundingsCheck.cpp:62
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::IncorrectRoundingsCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: IncorrectRoundingsCheck.cpp:33
clang::tidy::bugprone::IncorrectRoundingsCheck
Checks the usage of patterns known to produce incorrect rounding.
Definition: IncorrectRoundingsCheck.h:26
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27