Detailed Description

complex(selected_real_kind(6)) data type

Collaboration diagram for Complex (float):

Modules
module	bud_fs_carray2d

Data Types
type	fs_carray2d
	Finite stack with cyclic ability. More...

interface	new
	Internal initialization of finite stack holding cArray2D. More...

interface	new_fs_carray2d
	See interface #new More...

interface	push
	Adds/Pushes new element to the stack. More...

interface	pop
	Pop and (possibly) return the latest item in the stack. More...

interface	keep
	Keeps a fixed number of elements in the stack. More...

interface	get_elem
	Retrieve specific element from the stack. More...

interface	get_elemp
	Retrieve pointer to specific element in the stack. More...

interface	size
	Query number of currently stored elements in this stack. More...

interface	size_max
	Query maximum number of allowed elements in this stack. More...

interface	print
	Print, to std-out, some basic information of the data-container. More...

interface	assignment(=)
	Assignment of bud to another bud. More...

interface	initialize
	Initialization of data container. More...

interface	is_initialized
	Query whether bud is associated with any data. More...

interface	initialized
	See interface is_initialized More...

interface	is_initd
	See interface is_initialized More...

interface	is_same
	Check whether two buds point to the same data (function) More...

interface	same
	See interface #is_same More...

interface	delete
	Deletes the bud by decreasing references to the underlying data. More...

interface	nullify
	Nullifies the current bud. More...

interface	references
	Query number of references to the bud. More...

interface	refs
	See interface #references More...

Functions/Subroutines
procedure, public	delete => delete_
	See interface delete More...

procedure, public	nullify => nullify_
	See interface nullify More...

procedure, public	initialize => initialize_
	See interface initialize More...

procedure, public	is_initialized => is_initialized_
	See interface is_initialized More...

procedure, public	is_initd => is_initialized_
	See interface is_initialized More...

procedure, public	initialized => is_initialized_
	See interface is_initialized More...

procedure, public	is_same => is_same_
	See interface is_same More...

procedure, public	same => is_same_
	See interface is_same More...

procedure, public	references => references_
	See interface references More...

procedure, public	refs => references_
	See interface references More...

procedure, public	print => print_
	See interface print More...

procedure, public	new => new_
	See interface new More...

procedure, public	push => push_
	See interface push More...

procedure, public	pop => pop_
	See interface pop More...

procedure, public	keep => keep_
	See interface keep More...

procedure, public	get_elem => get_elem_
	See interface get_elem More...

procedure, public	get => get_elem_
	See interface get_elem More...

procedure, public	get_elemp => get_elemp_
	See interface get_elemp More...

procedure, public	getp => get_elemp_
	See interface get_elemp More...

procedure, public	size => size_elem_
	See interface size More...

procedure, public	size_max => size_max_elem_
	See interface size_max More...

subroutine	new_ (this, nel)

subroutine	new_ (this, nel)

subroutine	push_ (this, item)

subroutine	pop_ (this, item)

subroutine	pop_delete_ (this, top, bot)

subroutine	keep_ (this, top, bot)

subroutine	get_elem_ (this, elem, iel)

subroutine	get_elemp_ (this, p, iel)

elemental integer function	size_elem_ (this)

elemental integer function	size_max_elem_ (this)

subroutine	print_ (this, info, indent)

subroutine	assign_ (lhs, rhs)

subroutine	initialize_ (this)

pure logical function	is_initialized_ (this)

pure logical function	is_initialized_ (this)

pure logical function	is_initialized_ (this)

elemental logical function	is_same_ (lhs, rhs)

elemental logical function	is_same_ (lhs, rhs)

elemental subroutine	delete_ (this)

elemental subroutine	nullify_ (this)

elemental integer function	references_ (this)

elemental integer function	references_ (this)

subroutine	initialize_ (this)

pure logical function	is_initialized_ (this)

elemental logical function	is_same_ (lhs, rhs)

elemental subroutine	delete_ (this)

elemental subroutine	nullify_ (this)

subroutine	assign_ (lhs, rhs)

elemental integer function	references_ (this)

subroutine	new_ (this, nel)

subroutine	push_ (this, item)

subroutine	pop_ (this, item)

subroutine	pop_delete_ (this, top, bot)

subroutine	keep_ (this, top, bot)

subroutine	get_elem_ (this, elem, iel)

subroutine	get_elemp_ (this, p, iel)

elemental integer function	size_elem_ (this)

elemental integer function	size_max_elem_ (this)

subroutine	print_ (this, info, indent)

Variables
character(len=*), parameter, private	bud_mod = "bud_" // "bud_FS_cArray2D"
	Name of module. More...

character(len=*), parameter, private	bud_type = "FS_cArray2D"
	Name of bud in this module. More...

integer, parameter, public	bud_fstack_all = 0
	Special parameter for popping all elements. More...

Function/Subroutine Documentation

subroutine assign_	(	class(fs_carray2d), intent(inout)	lhs,
		class(fs_carray2d), intent(in)	rhs
	)

private

Parameters

[in,out]	lhs	contains `rhs` after exit
[in]	rhs	copy the containing element bud

subroutine bud_fs_carray2d::assign_	(	class(fs_carray2d), intent(inout)	lhs,
		class(fs_carray2d), intent(in)	rhs
	)

private

Parameters

[in,out]	lhs	contains `rhs` after exit
[in]	rhs	copy the containing element bud

procedure, public delete ( )

See interface delete

elemental subroutine delete_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this returned bud is un-initialized with no data associated

elemental subroutine bud_fs_carray2d::delete_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this returned bud is un-initialized with no data associated

Here is the call graph for this function:

procedure, public get ( )

See interface get_elem

procedure, public get_elem ( )

See interface get_elem

subroutine get_elem_	(	class(fs_carray2d), intent(in)	this,
		type(carray2d), intent(inout)	elem,
		integer, intent(in), optional	iel
	)

private

Parameters

[in]	this	stack to retrieve element from
[in,out]	elem	returned item stored in element `iel`
[in]	iel	optional=`size(this)` index of element to return. May be negative to offset from the top

subroutine bud_fs_carray2d::get_elem_	(	class(fs_carray2d), intent(in)	this,
		type(carray2d), intent(inout)	elem,
		integer, intent(in), optional	iel
	)

private

Parameters

[in]	this	stack to retrieve element from
[in,out]	elem	returned item stored in element `iel`
[in]	iel	optional=`size(this)` index of element to return. May be negative to offset from the top

procedure, public get_elemp ( )

See interface get_elemp

subroutine get_elemp_	(	class(fs_carray2d), intent(in)	this,
		type(carray2d), pointer	p,
		integer, intent(in), optional	iel
	)

private

Parameters

[in]	this	stack to retrieve pointer element from
	p	pointer to the element `iel`
[in]	iel	optional=`size(this)` index of element to return. May be negative to offset from top.

subroutine bud_fs_carray2d::get_elemp_	(	class(fs_carray2d), intent(in)	this,
		type(carray2d), pointer	p,
		integer, intent(in), optional	iel
	)

private

Parameters

[in]	this	stack to retrieve pointer element from
	p	pointer to the element `iel`
[in]	iel	optional=`size(this)` index of element to return. May be negative to offset from top.

procedure, public getp ( )

See interface get_elemp

procedure, public initialize ( )

See interface initialize

subroutine initialize_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this bud that is initialized

subroutine bud_fs_carray2d::initialize_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this bud that is initialized

procedure, public initialized ( )

See interface is_initialized

procedure, public is_initd ( )

See interface is_initialized

procedure, public is_initialized ( )

See interface is_initialized

pure logical function is_initialized_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this check if this bud is initialized

Returns: .true. if it is associated, else .false.

pure logical function is_initialized_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this check if this bud is initialized

Returns: .true. if it is associated, else .false.

pure logical function is_initialized_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this check if this bud is initialized

Returns: .true. if it is associated, else .false.

pure logical function bud_fs_carray2d::is_initialized_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this check if this bud is initialized

Returns: .true. if it is associated, else .false.

procedure, public is_same ( )

See interface is_same

elemental logical function is_same_	(	class(fs_carray2d), intent(in)	lhs,
		class(fs_carray2d), intent(in)	rhs
	)

private

Parameters

[in]	lhs	first bud
[in]	rhs	second bud

Returns: .true. if lhs and rhs point to the same data

elemental logical function is_same_	(	class(fs_carray2d), intent(in)	lhs,
		class(fs_carray2d), intent(in)	rhs
	)

private

Parameters

[in]	lhs	first bud
[in]	rhs	second bud

Returns: .true. if lhs and rhs point to the same data

elemental logical function bud_fs_carray2d::is_same_	(	class(fs_carray2d), intent(in)	lhs,
		class(fs_carray2d), intent(in)	rhs
	)

private

Parameters

[in]	lhs	first bud
[in]	rhs	second bud

Returns: .true. if lhs and rhs point to the same data

procedure, public keep ( )

See interface keep

subroutine keep_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in), optional	top,
		integer, intent(in), optional	bot
	)

private

Parameters

[in,out]	this	stack to operate on
[in]	top	optional=1 number of elements kept from the top
[in]	bot	optional=__null__ number of elements kept from the bottom, only used if `top` is not supplied.

subroutine bud_fs_carray2d::keep_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in), optional	top,
		integer, intent(in), optional	bot
	)

private

Parameters

[in,out]	this	stack to operate on
[in]	top	optional=1 number of elements kept from the top
[in]	bot	optional=__null__ number of elements kept from the bottom, only used if `top` is not supplied.

procedure, public new ( )

See interface new

subroutine new_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in)	nel
	)

private

Parameters

[in,out]	this	initialize the finite stack
[in]	nel	maximum number of elements that may be contained in the stack

subroutine new_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in)	nel
	)

private

Parameters

[in,out]	this	initialize the finite stack
[in]	nel	maximum number of elements that may be contained in the stack

subroutine bud_fs_carray2d::new_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in)	nel
	)

private

Parameters

[in,out]	this	initialize the finite stack
[in]	nel	maximum number of elements that may be contained in the stack

procedure, public nullify ( )

See interface nullify

elemental subroutine nullify_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this nullify references from this bud

elemental subroutine bud_fs_carray2d::nullify_ ( class(fs_carray2d), intent(inout) this )

private

Parameters

[in,out] this nullify references from this bud

procedure, public pop ( )

See interface pop

subroutine bud_fs_carray2d::pop_	(	class(fs_carray2d), intent(inout)	this,
		type(carray2d), intent(inout)	item
	)

private

Parameters

[in,out]	this	stack that gets removed an item
[in,out]	item	returned element from the top of the stack

subroutine pop_	(	class(fs_carray2d), intent(inout)	this,
		type(carray2d), intent(inout)	item
	)

private

Parameters

[in,out]	this	stack that gets removed an item
[in,out]	item	returned element from the top of the stack

subroutine pop_delete_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in), optional	top,
		integer, intent(in), optional	bot
	)

private

Parameters

[in,out]	this	stack that gets removed an item
[in]	top	optional=1 number of popped elements from top. If BUD_FSTACK_ALL is supplied it will clear all elements.
[in]	bot	optional=__null__ has precedence if `top` not supplied. Pops `bot` elements from the bottom of the stack.

subroutine bud_fs_carray2d::pop_delete_	(	class(fs_carray2d), intent(inout)	this,
		integer, intent(in), optional	top,
		integer, intent(in), optional	bot
	)

private

Parameters

[in,out]	this	stack that gets removed an item
[in]	top	optional=1 number of popped elements from top. If BUD_FSTACK_ALL is supplied it will clear all elements.
[in]	bot	optional=__null__ has precedence if `top` not supplied. Pops `bot` elements from the bottom of the stack.

procedure, public print ( )

See interface print

subroutine print_	(	class(fs_carray2d), intent(in)	this,
		character(len=*), intent(in), optional	info,
		integer, intent(in), optional	indent
	)

private

Parameters

[in]	this	data type
[in]	info	optional="FS_cArray2D" additional information printed
[in]	indent	optional=1 possible indentation of printed statement

subroutine bud_fs_carray2d::print_	(	class(fs_carray2d), intent(in)	this,
		character(len=*), intent(in), optional	info,
		integer, intent(in), optional	indent
	)

private

Parameters

[in]	this	data type
[in]	info	optional="FS_cArray2D" additional information printed
[in]	indent	optional=1 possible indentation of printed statement

procedure, public push ( )

See interface push

subroutine bud_fs_carray2d::push_	(	class(fs_carray2d), intent(inout)	this,
		type(carray2d), intent(in)	item
	)

private

Parameters

[in,out]	this	stack that gets added an element
[in]	item	element added to the stack

subroutine push_	(	class(fs_carray2d), intent(inout)	this,
		type(carray2d), intent(in)	item
	)

private

Parameters

[in,out]	this	stack that gets added an element
[in]	item	element added to the stack

procedure, public references ( )

See interface references

elemental integer function references_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this reference counted bud

Returns: number of times this has been referenced

elemental integer function references_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this reference counted bud

Returns: number of times this has been referenced

elemental integer function bud_fs_carray2d::references_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in] this reference counted bud

Returns: number of times this has been referenced

procedure, public refs ( )

See interface references

procedure, public same ( )

See interface is_same

procedure, public size ( )

See interface size

elemental integer function size_elem_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in,out] this stack to count element from

Returns: number of currently stored elements

elemental integer function bud_fs_carray2d::size_elem_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in,out] this stack to count element from

Returns: number of currently stored elements

procedure, public size_max ( )

See interface size_max

elemental integer function size_max_elem_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in,out] this stack that is queried maximum size of

Returns: maximum number of allowed elements

elemental integer function bud_fs_carray2d::size_max_elem_ ( class(fs_carray2d), intent(in) this )

private

Parameters

[in,out] this stack that is queried maximum size of

Returns: maximum number of allowed elements

Variable Documentation

integer, parameter, public bud_fstack_all = 0

Special parameter for popping all elements.

Allows one to pop/delete all elements in the stack. This basically performs a

n = size_max(this)
call delete(this)
call new(this, n)

character(len=*), parameter, private bud_mod = "bud_" // "bud_FS_cArray2D"

private

Name of module.

character(len=*), parameter, private bud_type = "FS_cArray2D"

private

Name of bud in this module.

Detailed Description

Modules

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

Variable Documentation