summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/if/predict-false.yml
blob: 44af5da410e15c9335a89d4b55cf722e543e94c0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Evaluates the integral expression and tells the compiler that the predicted
  value is false (0).
copyrights:
- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default: |
    ( _exp )
  variants:
  - definition: |
      ${/compiler/if/builtin-expect:/name}( ( _exp ), 0 )
    enabled-by:
    - defined(${/compiler/if/gnuc:/name})
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_PREDICT_FALSE
notes: null
params:
- description: |
    is the integral expression.
  dir: null
  name: _exp
return:
  return: |
    Returns the value of the integral expression and tells the compiler that
    the predicted value is false (0).
  return-values: []
type: interface