Detailed Description

logical data type

Collaboration diagram for Logical:

Modules
module	bud_barray3d

Data Types
type	barray3d
	Array data type. More...

interface	new
	Create a new bArray3D. More...

interface	new_barray3d
	See interface #new More...

interface	arrayp
	Retrieve pointer to array in the bud. More...

interface	size
	Query dimension of array (or total size) More...

interface	init_array
	Initialize array values to a specific value. 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, private	new_dim_

procedure, private	new_copy_

generic, public	new => new_dim_, new_copy_
	See interface new More...

procedure, public	arrayp => get_arrayp_
	See interface arrayp More...

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

procedure, public	init_array => init_array_
	See interface init_array More...

subroutine	new_dim_ (this, d1, d2, d3, val)

subroutine	new_copy_ (this, array)

subroutine	new_dim_ (this, d1, d2, d3, val)

subroutine	new_copy_ (this, array)

logical function, dimension(:,:,:), pointer, contiguous	get_arrayp_ (this)

pure integer function	size_ (this, dim)

subroutine	init_array_ (this, v)

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)

pure subroutine, private	delete_data (this)
	Internal routine for cleaning up the data container. More...

subroutine	new_dim_ (this, d1, d2, d3, val)

subroutine	new_copy_ (this, array)

logical function, dimension(:,:,:), pointer, contiguous	get_arrayp_ (this)

pure logical function	get_array_idx_ (this, i1, i2, i3 )

pure integer function	size_ (this, dim)

subroutine	init_array_ (this, v)

subroutine	print_ (this, info, indent)

Variables
integer, parameter, private	bud_id_len = 36
	bud_bArray3D documentation More...

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

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

Function/Subroutine Documentation

procedure, public arrayp ( )

See interface arrayp

subroutine bud_barray3d::assign_	(	class(barray3d), intent(inout)	lhs,
		class(barray3d), intent(in)	rhs
	)

private

Parameters

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

subroutine assign_	(	class(barray3d), intent(inout)	lhs,
		class(barray3d), 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(barray3d), intent(inout) this )

private

Parameters

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

elemental subroutine bud_barray3d::delete_ ( class(barray3d), 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:

pure subroutine, private bud_barray3d::delete_data ( type(barray3d_), intent(inout) this )

private

Internal routine for cleaning up the data container.

Developer This routine is only used internally to clean-up any data in the type. Should never be made public.

Here is the caller graph for this function:

pure logical function bud_barray3d::get_array_idx_	(	class(barray3d), intent(in)	this,
		integer, intent(in)	i1,
		integer, intent(in)	i2,
		integer, intent(in)	i3
	)

private

Parameters

[in]	this	the containing bud
[in]	i1	index in the array
[in]	i2	index in the array
[in]	i3	index in the array

Returns: the value in the specific indexed location of the array

logical function, dimension (:,:,:), pointer, contiguous get_arrayp_ ( class(barray3d), intent(in) this )

private

Parameters

[in] this array bud

Returns: a pointer to the data (contiguous)

logical function, dimension (:,:,:), pointer, contiguous bud_barray3d::get_arrayp_ ( class(barray3d), intent(in) this )

private

Parameters

[in] this array bud

Returns: a pointer to the data (contiguous)

procedure, public init_array ( )

See interface init_array

subroutine bud_barray3d::init_array_	(	class(barray3d), intent(inout)	this,
		logical, intent(in)	v
	)

private

Parameters

[in]	this	array bud
[in]	v	all elements of the contained array will be equal to `v` after the call

subroutine init_array_	(	class(barray3d), intent(inout)	this,
		logical, intent(in)	v
	)

private

Parameters

[in]	this	array bud
[in]	v	all elements of the contained array will be equal to `v` after the call

procedure, public initialize ( )

See interface initialize

subroutine bud_barray3d::initialize_ ( class(barray3d), intent(inout) this )

private

Parameters

[in,out] this bud that is initialized

subroutine initialize_ ( class(barray3d), 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 bud_barray3d::is_initialized_ ( class(barray3d), 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(barray3d), 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(barray3d), 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(barray3d), 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(barray3d), intent(in)	lhs,
		class(barray3d), 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_barray3d::is_same_	(	class(barray3d), intent(in)	lhs,
		class(barray3d), 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(barray3d), intent(in)	lhs,
		class(barray3d), intent(in)	rhs
	)

private

Parameters

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

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

generic, public new ( )

See interface new

procedure, private new_copy_ ( )

private

subroutine new_copy_	(	class(barray3d), intent(inout)	this,
		logical, dimension (:,:,:), intent(in)	array
	)

private

Parameters

[in,out]	this	array bud
[in]	array	array to dublicate in `this` (dimensions and values)

subroutine new_copy_	(	class(barray3d), intent(inout)	this,
		logical, dimension (:,:,:), intent(in)	array
	)

private

Parameters

[in,out]	this	array bud
[in]	array	array to dublicate in `this` (dimensions and values)

subroutine bud_barray3d::new_copy_	(	class(barray3d), intent(inout)	this,
		logical, dimension (:,:,:), intent(in)	array
	)

private

Parameters

[in,out]	this	array bud
[in]	array	array to dublicate in `this` (dimensions and values)

Here is the call graph for this function:

procedure, private new_dim_ ( )

private

subroutine new_dim_	(	class(barray3d), intent(inout)	this,
		integer, intent(in)	d1,
		integer, intent(in)	d2,
		integer, intent(in)	d3,
		logical, intent(in), optional	val
	)

private

Parameters

[in,out]	this	array bud
[in]	d1	size of the internal reference counted array (dim=1)
[in]	d2	size of the internal reference counted array (dim=2)
[in]	d3	size of the internal reference counted array (dim=3)
[in]	val	optional=__null__ initial value of all elements

subroutine new_dim_	(	class(barray3d), intent(inout)	this,
		integer, intent(in)	d1,
		integer, intent(in)	d2,
		integer, intent(in)	d3,
		logical, intent(in), optional	val
	)

private

Parameters

[in,out]	this	array bud
[in]	d1	size of the internal reference counted array (dim=1)
[in]	d2	size of the internal reference counted array (dim=2)
[in]	d3	size of the internal reference counted array (dim=3)
[in]	val	optional=__null__ initial value of all elements

subroutine bud_barray3d::new_dim_	(	class(barray3d), intent(inout)	this,
		integer, intent(in)	d1,
		integer, intent(in)	d2,
		integer, intent(in)	d3,
		logical, intent(in), optional	val
	)

private

Parameters

[in,out]	this	array bud
[in]	d1	size of the internal reference counted array (dim=1)
[in]	d2	size of the internal reference counted array (dim=2)
[in]	d3	size of the internal reference counted array (dim=3)
[in]	val	optional=__null__ initial value of all elements

Here is the caller graph for this function:

procedure, public nullify ( )

See interface nullify

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

private

Parameters

[in,out] this nullify references from this bud

elemental subroutine bud_barray3d::nullify_ ( class(barray3d), intent(inout) this )

private

Parameters

[in,out] this nullify references from this bud

procedure, public print ( )

See interface print

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

private

Parameters

[in]	this	array bud
[in]	info	optional="bArray3D" additional information printed
[in]	indent	optional=1 possible indentation of printed statement

Here is the call graph for this function:

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

private

Parameters

[in]	this	array bud
[in]	info	optional="bArray3D" additional information printed
[in]	indent	optional=1 possible indentation of printed statement

procedure, public references ( )

See interface references

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

private

Parameters

[in] this reference counted bud

Returns: number of times this has been referenced

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

private

Parameters

[in] this reference counted bud

Returns: number of times this has been referenced

elemental integer function bud_barray3d::references_ ( class(barray3d), 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

pure integer function size_	(	class(barray3d), intent(in)	this,
		integer, intent(in), optional	dim
	)

private

Parameters

[in]	this	bud container
[in]	dim	optional=__null__ along the specified dimension

Returns: the size of the contained array

pure integer function bud_barray3d::size_	(	class(barray3d), intent(in)	this,
		integer, intent(in), optional	dim
	)

private

Parameters

[in]	this	bud container
[in]	dim	optional=__null__ along the specified dimension

Returns: the size of the contained array

Here is the caller graph for this function:

Variable Documentation

integer, parameter, private bud_id_len = 36

private

bud_bArray3D documentation

The detailed implementation of the bArray3D type.

Note This documentation is duplicated in all types with different precision. Size of ID parameter for bud data-containers

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

private

Name of module.

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

private

Name of bud in this module.

Detailed Description

Modules

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

Variable Documentation