NAG Library ManualKeyword Search:

NAG Library Routine Document

s22aaf (legendre_p)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

s22aaf returns a sequence of values for either the unnormalized or normalized Legendre functions of the first kind

P_{n}^{m} (x)

\bar{P_{n}^{m}} (x)

for real

x

of a given order

m

and degree

n = 0, 1, \dots, N

2

Specification

Fortran Interface

Subroutine s22aaf (

mode, x, m, nl, p, ifail)

Integer, Intent (In)	::	mode, m, nl
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	x
Real (Kind=nag_wp), Intent (Out)	::	p(0:nl)

C Header Interface

#include nagmk26.h

void	s22aaf_ ( const Integer mode, const double x, const Integer m, const Integer nl, double p[], Integer *ifail)

3

Description

s22aaf evaluates a sequence of values for either the unnormalized or normalized Legendre (

m = 0

) or associated Legendre (

m \neq 0

) functions of the first kind

P_{n}^{m} (x)

\bar{P_{n}^{m}} (x)

, where

x

is real with

- 1 \leq x \leq 1

, of order

m

and degree

n = 0, 1, \dots, N

defined by

\begin{array}{lcl} P_{n}^{m} (x) & = & {(1 - x^{2})}^{m / 2} \frac{d^{m}}{d x^{m}} P_{n} (x) & if ​ m \geq 0, \\ P_{n}^{m} (x) & = & \frac{(n + m)!}{(n - m)!} P_{n}^{- m} (x) & if ​ m < 0 and \\ \bar{P_{n}^{m}} (x) & = & \sqrt{\frac{(2 n + 1)}{2} \frac{(n - m)!}{(n + m)!}} P_{n}^{m} (x) \end{array}

respectively;

P_{n} (x)

is the (unassociated) Legendre polynomial of degree

n

given by

P_{n} (x) \equiv P_{n}^{0} (x) = \frac{1}{2^{n} n!} \frac{d^{n}}{d x^{n}} {(x^{2} - 1)}^{n}

(the Rodrigues formula). Note that some authors (e.g., Abramowitz and Stegun (1972)) include an additional factor of

{(- 1)}^{m}

(the Condon–Shortley Phase) in the definitions of

P_{n}^{m} (x)

and

\bar{P_{n}^{m}} (x)

. They use the notation

P_{m n} (x) \equiv {(- 1)}^{m} P_{n}^{m} (x)

in order to distinguish between the two cases.

s22aaf is based on a standard recurrence relation described in Section 8.5.3 of Abramowitz and Stegun (1972). Constraints are placed on the values of

m

and

n

in order to avoid the possibility of machine overflow. It also sets the appropriate elements of the array p (see Section 5) to zero whenever the required function is not defined for certain values of

m

and

n

(e.g.,

m = - 5

and

n = 3

4

References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications

5

Arguments

1: $mode$ – IntegerInput

On entry: indicates whether the sequence of function values is to be returned unnormalized or normalized.

$mode = 1$: The sequence of function values is returned unnormalized.
$mode = 2$: The sequence of function values is returned normalized.

Constraint:

mode = 1

2

2: $x$ – Real (Kind=nag_wp)Input

On entry: the argument

x

of the function.

Constraint:

abs (x) \leq 1.0

3: $m$ – IntegerInput

On entry: the order

m

of the function.

Constraint:

abs (m) \leq 27

4: $nl$ – IntegerInput

On entry: the degree

N

of the last function required in the sequence.

Constraints:

$nl \geq 0$ ;
if $m = 0$ , $nl \leq 100$ ;
if $m \neq 0$ , $nl \leq 55 - abs (m)$ .

5: $p (0 : nl)$ – Real (Kind=nag_wp) arrayOutput

On exit: the required sequence of function values as follows:

if $mode = 1$ , $p (n)$ contains $P_{n}^{m} (x)$ , for $n = 0, 1, \dots, N$ ;
if $mode = 2$ , $p (n)$ contains $\bar{P_{n}^{m}} (x)$ , for $n = 0, 1, \dots, N$ .

6: $ifail$ – IntegerInput/Output

On entry: ifail must be set to

0

- 1 ​ or ​ 1

. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value

- 1 ​ or ​ 1

is recommended. If the output of error messages is undesirable, then the value

1

is recommended. Otherwise, if you are not familiar with this argument, the recommended value is

0

. When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$

On entry,	$abs (x) > 1.0$ ,
or	$mode \neq 1$ or $2$ ,
or	$nl < 0$ ,
or	$nl > 100$ when $m = 0$ ,
or	$abs (m) > 27$ ,
or	$nl + abs (m) > 55$ when $m \neq 0$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The computed function values should be accurate to within a small multiple of the machine precision except when underflow (or overflow) occurs, in which case the true function values are within a small multiple of the underflow (or overflow) threshold of the machine.

8

Parallelism and Performance

s22aaf is not threaded in any implementation.

9

Further Comments

None.

10

Example

This example reads the values of the arguments

x

m

and

N

from a file, calculates the sequence of unnormalized associated Legendre function values

P_{n}^{m} (x), P_{n + 1}^{m} (x), \dots, P_{n + N}^{m} (x)

, and prints the results.

NAG Library Routine Document

s22aaf (legendre_p)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

6

Error Indicators and Warnings

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

10.2

Program Data

10.3

Program Results