vector_m – BROWNPAK

Implements a vector as an extendable array.

Uses

- constants_m
- qsort_m
Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Interfaces

ivector_init dvector_init assignment(=)

Derived Types

ivector_t dvector_t

Functions

ivector_get_len dvector_get_len ivector_get_val dvector_get_val ivector_pop dvector_pop

Interfaces

public interface ivector_init

public interface ivector_init()

Arguments
None
public subroutine ivector_from_array(this, x)

Creates an ivector with all elements from an array

Arguments

Type Intent Optional Attributes Name

type(ivector_t), intent(inout) :: this

integer, intent(in), dimension(:) :: x

public interface dvector_init

public interface dvector_init()

Arguments
None
public subroutine dvector_from_array(this, x)

Creates a dvector with all elements from an array

Arguments

Type Intent Optional Attributes Name

type(dvector_t), intent(inout) :: this

real(kind=rp), intent(in), dimension(:) :: x

public interface assignment(=)

public subroutine ivector_assign(this, other)

Copies the contents of ivector other to ivector this

Arguments

Type Intent Optional Attributes Name

class(ivector_t), intent(inout) :: this

class(ivector_t), intent(in) :: other
public subroutine dvector_assign(this, other)

Copies the contents of dvector other to dvector this

Arguments

Type Intent Optional Attributes Name

class(dvector_t), intent(inout) :: this

class(dvector_t), intent(in) :: other
public subroutine i_dvector_assign(this, other)

Copies the contents of ivector other to dvector this. Integers are cast to reals.

Arguments

Type Intent Optional Attributes Name

class(dvector_t), intent(inout) :: this

class(ivector_t), intent(in) :: other

Derived Types

type, public :: ivector_t

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	len_init	=	8
integer,	public		::	len	=	0
integer,	public		::	len_max	=	16
integer,	public,	dimension(:), allocatable	::	buffer

Type-Bound Procedures

procedure, public :: delete => ivector_delete
procedure, public :: clear => ivector_clear
procedure, public :: get_val => ivector_get_val
procedure, public :: set_val => ivector_set_val
procedure, public :: get_data => ivector_get_data
procedure, public :: append => ivector_append
procedure, public :: pop => ivector_pop
procedure, public :: resize => ivector_resize
procedure, public :: shrink_to_fit => ivector_shrink_to_fit
procedure, public :: sort => ivector_sort
procedure, public :: unique => ivector_unique
procedure, public :: print => ivector_print

type, public :: dvector_t

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	len_init	=	8
integer,	public		::	len	=	0
integer,	public		::	len_max	=	16
real(kind=rp),	public,	dimension(:), allocatable	::	buffer

Type-Bound Procedures

procedure, public :: delete => dvector_delete
procedure, public :: clear => dvector_clear
procedure, public :: get_val => dvector_get_val
procedure, public :: set_val => dvector_set_val
procedure, public :: get_data => dvector_get_data
procedure, public :: append => dvector_append
procedure, public :: pop => dvector_pop
procedure, public :: resize => dvector_resize
procedure, public :: shrink_to_fit => dvector_shrink_to_fit
procedure, public :: sort => dvector_sort
procedure, public :: unique => dvector_unique
procedure, public :: print => dvector_print

Functions

public function ivector_get_len(this) result(res)

Returns the length of an ivector

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(in)			::	this

Return Value integer

public function dvector_get_len(this) result(res)

Returns the length of a dvector

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(in)			::	this

Return Value integer

public function ivector_get_val(this, i) result(res)

Returns the ith element of an ivector.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(in)			::	this
integer,	intent(in)			::	i

Return Value integer

public function dvector_get_val(this, i) result(res)

Returns the ith element of a dvector.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(in)			::	this
integer,	intent(in)			::	i

Return Value real(kind=rp)

public function ivector_pop(this) result(val)

Removes the last element and returns it. Calling this method on an empty list

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this

Return Value integer

public function dvector_pop(this) result(val)

Removes the last element and returns it. Calling this method on an empty list

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this

Return Value real(kind=rp)

Subroutines

public subroutine ivector_init(this, len_init, ierr)

Creates an empty ivector with all elements equal to zero.

Arguments

Type	Intent	Optional		Name
type(ivector_t),	intent(inout)		::	this
integer,	intent(in),	optional	::	len_init	Must be > 0
integer,	intent(out),	optional	::	ierr

public subroutine dvector_init(this, len_init, ierr)

Creates an empty dvector with all elements equal to zero.

Arguments

Type	Intent	Optional		Name
type(dvector_t),	intent(inout)		::	this
integer,	intent(in),	optional	::	len_init	Must be > 0
integer,	intent(out),	optional	::	ierr

public subroutine ivector_from_array(this, x)

Creates an ivector with all elements from an array

Arguments

Type	Intent	Optional	Attributes		Name
type(ivector_t),	intent(inout)			::	this
integer,	intent(in),		dimension(:)	::	x

public subroutine dvector_from_array(this, x)

Creates a dvector with all elements from an array

Arguments

Type	Intent	Optional	Attributes		Name
type(dvector_t),	intent(inout)			::	this
real(kind=rp),	intent(in),		dimension(:)	::	x

public subroutine ivector_delete(this)

Deletes an ivector. No access is allowed to this object after this call.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this

public subroutine dvector_delete(this)

Deletes a dvector. No access is allowed to this object after this call.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this

public subroutine ivector_clear(this)

Clears an ivector. Access allowed after a call to clear.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this

public subroutine dvector_clear(this)

Clears a dvector. Access allowed after a call to clear.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this

public subroutine ivector_assign(this, other)

Copies the contents of ivector other to ivector this

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this
class(ivector_t),	intent(in)			::	other

public subroutine dvector_assign(this, other)

Copies the contents of dvector other to dvector this

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this
class(dvector_t),	intent(in)			::	other

public subroutine i_dvector_assign(this, other)

Copies the contents of ivector other to dvector this. Integers are cast to reals.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this
class(ivector_t),	intent(in)			::	other

public subroutine ivector_set_val(this, i, val)

Sets the value of the ith element of an ivector. No bounds check is performed.

Arguments

Type	Intent		Name
class(ivector_t),	intent(inout)	::	this
integer,	intent(in)	::	i
integer,	intent(in)	::	val

public subroutine dvector_set_val(this, i, val)

Sets the value of the ith element of a dvector. No bounds check is performed.

Arguments

Type	Intent		Name
class(dvector_t),	intent(inout)	::	this
integer,	intent(in)	::	i
real(kind=rp),	intent(in)	::	val

public subroutine ivector_append(this, val)

Adds an element to the end of an ivector. Reallocation will take place if required.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this
integer,	intent(in)			::	val

public subroutine dvector_append(this, val)

Adds an element to the end of a dvector. Reallocation will take place if required.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this
real(kind=rp),	intent(in)			::	val

public subroutine ivector_get_data(this, res, ibeg, iend)

Returns a pointer to the underlying data of an ivector

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(in),		target	::	this
integer,	intent(out),		dimension(:), pointer	::	res
integer,	intent(in),	optional		::	ibeg
integer,	intent(in),	optional		::	iend

public subroutine dvector_get_data(this, res, ibeg, iend)

Returns a pointer to the underlying data of a dvector

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(in),		target	::	this
real(kind=rp),	intent(out),		dimension(:), pointer	::	res
integer,	intent(in),	optional		::	ibeg
integer,	intent(in),	optional		::	iend

public subroutine ivector_resize(this, new_size, ierr)

Resizes a vector to a given size. Existing data is truncated if desired size is smaller than current size. Otherwise, the empty spaces are filled with zero.

Arguments

Type	Intent	Optional		Name
class(ivector_t),	intent(inout)		::	this
integer,	intent(in)		::	new_size
integer,	intent(out),	optional	::	ierr

public subroutine dvector_resize(this, new_size, ierr)

Resizes a vector to a given size. Existing data is truncated if desired size is smaller than current size. Otherwise, the empty spaces are filled with zero.

Arguments

Type	Intent	Optional		Name
class(dvector_t),	intent(inout)		::	this
integer,	intent(in)		::	new_size
integer,	intent(out),	optional	::	ierr

public subroutine ivector_shrink_to_fit(this, ierr)

Releases additional memory to fit underlying data of an ivector to a size this%len_init.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this
integer,	intent(out),	optional		::	ierr

public subroutine dvector_shrink_to_fit(this, ierr)

Releases additional memory to fit underlying data of a dvector to a size this%len_init.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this
integer,	intent(out),	optional		::	ierr

public subroutine ivector_sort(this, order)

Sorts an ivector in ascending order. If order is provided, it will contain the sorted indices. The size of order must be at least this%len.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this
integer,	intent(out),	optional	dimension(:)	::	order

public subroutine dvector_sort(this, order)

Sorts a dvector in ascending order. If order is provided, it will contain the sorted indices. The size of order must be at least this%len.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this
integer,	intent(out),	optional	dimension(:)	::	order

public subroutine ivector_unique(this)

Sorts and removes all duplicate entries of an ivector. Note that the internal buffer size remains unchanged. To reduce the buffer size, call ivector_shrink_to_fit.

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(inout)			::	this

public subroutine dvector_unique(this)

Sorts and removes all duplicate entries of a dvector. Note that the internal buffer size remains unchanged. To reduce the buffer size, call dvector_shrink_to_fit.

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(inout)			::	this

public subroutine ivector_print(this)

Prints an ivector

Arguments

Type	Intent	Optional	Attributes		Name
class(ivector_t),	intent(in)			::	this

public subroutine dvector_print(this)

Prints a dvector

Arguments

Type	Intent	Optional	Attributes		Name
class(dvector_t),	intent(in)			::	this

vector_m Module

Contents

Uses

Used by

Contents

Interfaces

public interface ivector_init

public interface ivector_init()

Arguments

public subroutine ivector_from_array(this, x)

Arguments

public interface dvector_init

public interface dvector_init()

Arguments

public subroutine dvector_from_array(this, x)

Arguments

public interface assignment(=)

public subroutine ivector_assign(this, other)

Arguments

public subroutine dvector_assign(this, other)

Arguments

public subroutine i_dvector_assign(this, other)

Arguments

Derived Types

type, public :: ivector_t

Components

Type-Bound Procedures

type, public :: dvector_t

Components

Type-Bound Procedures

Functions

public function ivector_get_len(this) result(res)

Arguments

Return Value integer

public function dvector_get_len(this) result(res)

Arguments

Return Value integer

public function ivector_get_val(this, i) result(res)

Arguments

Return Value integer

public function dvector_get_val(this, i) result(res)

Arguments

Return Value real(kind=rp)

public function ivector_pop(this) result(val)

Arguments

Return Value integer

public function dvector_pop(this) result(val)

Arguments

Return Value real(kind=rp)

Subroutines

public subroutine ivector_init(this, len_init, ierr)

Arguments

public subroutine dvector_init(this, len_init, ierr)

Arguments

public subroutine ivector_from_array(this, x)

Arguments

public subroutine dvector_from_array(this, x)

Arguments

public subroutine ivector_delete(this)

Arguments

public subroutine dvector_delete(this)

Arguments

public subroutine ivector_clear(this)

Arguments

public subroutine dvector_clear(this)

Arguments

public subroutine ivector_assign(this, other)

Arguments

public subroutine dvector_assign(this, other)

Arguments

public subroutine i_dvector_assign(this, other)

Arguments

public subroutine ivector_set_val(this, i, val)

Arguments

public subroutine dvector_set_val(this, i, val)

Arguments

public subroutine ivector_append(this, val)

Arguments

public subroutine dvector_append(this, val)

Arguments