Skip to content

Commit 8f5cadc

Browse files
mrjbq7John Benediktsson
authored andcommitted
docs: updates
1 parent e5aab28 commit 8f5cadc

10 files changed

Lines changed: 277 additions & 86 deletions

‎docs/func_groups/cycle_indicators.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22
### HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period
33
NOTE: The ``HT_DCPERIOD`` function has an unstable period.
44
```python
5-
real = HT_DCPERIOD(real)
5+
real = HT_DCPERIOD(close)
66
```
77

88
### HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase
99
NOTE: The ``HT_DCPHASE`` function has an unstable period.
1010
```python
11-
real = HT_DCPHASE(real)
11+
real = HT_DCPHASE(close)
1212
```
1313

1414
### HT_PHASOR - Hilbert Transform - Phasor Components
1515
NOTE: The ``HT_PHASOR`` function has an unstable period.
1616
```python
17-
inphase, quadrature = HT_PHASOR(real)
17+
inphase, quadrature = HT_PHASOR(close)
1818
```
1919

2020
### HT_SINE - Hilbert Transform - SineWave
2121
NOTE: The ``HT_SINE`` function has an unstable period.
2222
```python
23-
sine, leadsine = HT_SINE(real)
23+
sine, leadsine = HT_SINE(close)
2424
```
2525

2626
### HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode
2727
NOTE: The ``HT_TRENDMODE`` function has an unstable period.
2828
```python
29-
integer = HT_TRENDMODE(real)
29+
integer = HT_TRENDMODE(close)
3030
```
3131

3232

3333
[Documentation Index](../doc_index.md)
34-
3534
[FLOAT_RIGHTAll Function Groups](../funcs.md)

‎docs/func_groups/math_operators.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,64 @@
11
# Math Operator Functions
22
### ADD - Vector Arithmetic Add
33
```python
4-
real = ADD(real0, real1)
4+
real = ADD(high, low)
5+
```
6+
7+
### CUMSUM - Cumulative Sum
8+
```python
9+
real = CUMSUM(close)
510
```
611

712
### DIV - Vector Arithmetic Div
813
```python
9-
real = DIV(real0, real1)
14+
real = DIV(high, low)
1015
```
1116

1217
### MAX - Highest value over a specified period
1318
```python
14-
real = MAX(real, timeperiod=30)
19+
real = MAX(close, timeperiod=30)
1520
```
1621

1722
### MAXINDEX - Index of highest value over a specified period
1823
```python
19-
integer = MAXINDEX(real, timeperiod=30)
24+
integer = MAXINDEX(close, timeperiod=30)
2025
```
2126

2227
### MIN - Lowest value over a specified period
2328
```python
24-
real = MIN(real, timeperiod=30)
29+
real = MIN(close, timeperiod=30)
2530
```
2631

2732
### MININDEX - Index of lowest value over a specified period
2833
```python
29-
integer = MININDEX(real, timeperiod=30)
34+
integer = MININDEX(close, timeperiod=30)
3035
```
3136

3237
### MINMAX - Lowest and highest values over a specified period
3338
```python
34-
min, max = MINMAX(real, timeperiod=30)
39+
min, max = MINMAX(close, timeperiod=30)
3540
```
3641

3742
### MINMAXINDEX - Indexes of lowest and highest values over a specified period
3843
```python
39-
minidx, maxidx = MINMAXINDEX(real, timeperiod=30)
44+
minidx, maxidx = MINMAXINDEX(close, timeperiod=30)
4045
```
4146

4247
### MULT - Vector Arithmetic Mult
4348
```python
44-
real = MULT(real0, real1)
49+
real = MULT(high, low)
4550
```
4651

4752
### SUB - Vector Arithmetic Subtraction
4853
```python
49-
real = SUB(real0, real1)
54+
real = SUB(high, low)
5055
```
5156

5257
### SUM - Summation
5358
```python
54-
real = SUM(real, timeperiod=30)
59+
real = SUM(close, timeperiod=30)
5560
```
5661

5762

5863
[Documentation Index](../doc_index.md)
59-
6064
[FLOAT_RIGHTAll Function Groups](../funcs.md)

‎docs/func_groups/math_transform.md‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,79 @@
11
# Math Transform Functions
22
### ACOS - Vector Trigonometric ACos
33
```python
4-
real = ACOS(real)
4+
real = ACOS(close)
55
```
66

77
### ASIN - Vector Trigonometric ASin
88
```python
9-
real = ASIN(real)
9+
real = ASIN(close)
1010
```
1111

1212
### ATAN - Vector Trigonometric ATan
1313
```python
14-
real = ATAN(real)
14+
real = ATAN(close)
1515
```
1616

1717
### CEIL - Vector Ceil
1818
```python
19-
real = CEIL(real)
19+
real = CEIL(close)
2020
```
2121

2222
### COS - Vector Trigonometric Cos
2323
```python
24-
real = COS(real)
24+
real = COS(close)
2525
```
2626

2727
### COSH - Vector Trigonometric Cosh
2828
```python
29-
real = COSH(real)
29+
real = COSH(close)
3030
```
3131

3232
### EXP - Vector Arithmetic Exp
3333
```python
34-
real = EXP(real)
34+
real = EXP(close)
3535
```
3636

3737
### FLOOR - Vector Floor
3838
```python
39-
real = FLOOR(real)
39+
real = FLOOR(close)
4040
```
4141

4242
### LN - Vector Log Natural
4343
```python
44-
real = LN(real)
44+
real = LN(close)
4545
```
4646

4747
### LOG10 - Vector Log10
4848
```python
49-
real = LOG10(real)
49+
real = LOG10(close)
5050
```
5151

5252
### SIN - Vector Trigonometric Sin
5353
```python
54-
real = SIN(real)
54+
real = SIN(close)
5555
```
5656

5757
### SINH - Vector Trigonometric Sinh
5858
```python
59-
real = SINH(real)
59+
real = SINH(close)
6060
```
6161

6262
### SQRT - Vector Square Root
6363
```python
64-
real = SQRT(real)
64+
real = SQRT(close)
6565
```
6666

6767
### TAN - Vector Trigonometric Tan
6868
```python
69-
real = TAN(real)
69+
real = TAN(close)
7070
```
7171

7272
### TANH - Vector Trigonometric Tanh
7373
```python
74-
real = TANH(real)
74+
real = TANH(close)
7575
```
7676

7777

7878
[Documentation Index](../doc_index.md)
79-
8079
[FLOAT_RIGHTAll Function Groups](../funcs.md)

0 commit comments

Comments
 (0)