summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/pow.yml
blob: da2fa42739c2c5bcd09c8890e97464de56668589 (plain)
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
DOCUMENTATION:
  name: pow
  version_added: "1.9"
  short_description: power of (math operation)
  description:
    - Math operation that returns the Nth power of inputed number, C(X ^ N).
  notes:
    - This is a passthrough to Python's C(math.pow).
  positional: _input, _power
  options:
    _input:
      description: The base.
      type: float
      required: true
    _power:
      description: Which power (exponent) to use.
      type: float
      required: true

EXAMPLES: |

  # => 32768
  eight_power_five: "{{ 8 | pow(5) }}"

  # 4
  square_of_2: "{{ 2 | pow(2) }}"

  # me ^ 3
  cube_me: "{{ me | pow(3) }}"

RETURN:
  _value:
    description: Resulting number.
    type: float