Skip to content

Commit f6ac41b

Browse files
committed
Added spec for special functions
1 parent 274f542 commit f6ac41b

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

doc/specs/stdlib_specialfunctions.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: specialfunctions
3+
---
4+
5+
# Special functions
6+
7+
[TOC]
8+
9+
## `legendre` - Calculate Legendre polynomials
10+
11+
### Status
12+
13+
Experimental
14+
15+
### Description
16+
17+
Computes the value of the n-th Legendre polynomial at a specified point.
18+
Currently only 64 bit floating point is supported.
19+
20+
This is an `elemental` function.
21+
22+
### Syntax
23+
24+
`result = [[stdlib_specialfunctions(module):legendre(interface)]](n, x)`
25+
26+
### Arguments
27+
28+
`n`: Shall be a scalar of type `real(real64)`.
29+
30+
`x`: Shall be a scalar or array (this function is elemental) of type `real(real64)`.
31+
32+
### Return value
33+
34+
The function result will be the value of the `n`-th Legendre polynomial, evaluated at `x`.
35+
36+
37+
38+
## `dlegendre` - Calculate first derivatives of Legendre polynomials
39+
40+
### Status
41+
42+
Experimental
43+
44+
### Description
45+
46+
Computes the value of the first derivative of the n-th Legendre polynomial at a specified point.
47+
Currently only 64 bit floating point is supported.
48+
49+
This is an `elemental` function.
50+
51+
### Syntax
52+
53+
`result = [[stdlib_specialfunctions(module):dlegendre(interface)]](n, x)`
54+
55+
### Arguments
56+
57+
`n`: Shall be a scalar of type `real(real64)`.
58+
59+
`x`: Shall be a scalar or array (this function is elemental) of type `real(real64)`.
60+
61+
### Return value
62+
63+
The function result will be the value of the first derivative of the `n`-th Legendre polynomial, evaluated at `x`.
64+

0 commit comments

Comments
 (0)