NTPoly
Data Types | Functions/Subroutines
tripletlistmodule_wrp Module Reference

A module for wrapping the triplet list data type. More...

Data Types

type  tripletlist_wrp
 A wrapper for the triplet list data type. More...
 

Functions/Subroutines

pure subroutine, public constructtripletlist_wrp (ih_this, size)
 Wrap the triplet list constructor. More...
 
pure subroutine, public destructtripletlist_wrp (ih_this)
 Destructs a triplet list. More...
 
pure subroutine, public resizetripletlist_wrp (ih_this, size)
 Increase the size of a triplet list. More...
 
pure subroutine, public appendtotripletlist_wrp (ih_this, index_column, index_row, point_value)
 
pure subroutine, public settripletat_wrp (ih_this, index, index_column, index_row, point_value)
 Set the value of a triplet at a particular index. More...
 
pure subroutine, public gettripletat_wrp (ih_this, index, index_column, index_row, point_value)
 Get the value of a triplet at a particular index. More...
 
pure subroutine, public sorttripletlist_wrp (ih_this, matrix_columns, ih_sorted)
 Sorts a triplet list by index values. More...
 

Detailed Description

A module for wrapping the triplet list data type.

Function/Subroutine Documentation

◆ constructtripletlist_wrp()

pure subroutine, public tripletlistmodule_wrp::constructtripletlist_wrp ( integer(kind=c_int), dimension(size_wrp), intent(inout)  ih_this,
integer(kind=c_int), intent(in)  size 
)

Wrap the triplet list constructor.

Parameters
[out]ih_thishandle to a constructed Matrix Memory Pool object.
[in]sizeof the triplet list.

◆ destructtripletlist_wrp()

pure subroutine, public tripletlistmodule_wrp::destructtripletlist_wrp ( integer(kind=c_int), dimension(size_wrp), intent(inout)  ih_this)

Destructs a triplet list.

Parameters
[in,out]ih_thishandle to the triplet list to destruct.

◆ gettripletat_wrp()

pure subroutine, public tripletlistmodule_wrp::gettripletat_wrp ( integer(kind=c_int), dimension(size_wrp), intent(in)  ih_this,
integer(kind=c_int), intent(out)  index,
integer(kind=c_int), intent(out)  index_column,
integer(kind=c_int), intent(out)  index_row,
real(ntreal), intent(out)  point_value 
)

Get the value of a triplet at a particular index.

Parameters
[in,out]ih_thishandle to the triplet list to get.
[in]indexthe index at which to get the triplet.
[out]index_columnthe column value.
[out]index_rowthe row value.
[out]point_valuethe value at that point.

◆ resizetripletlist_wrp()

pure subroutine, public tripletlistmodule_wrp::resizetripletlist_wrp ( integer(kind=c_int), dimension(size_wrp), intent(inout)  ih_this,
integer(kind=c_int), intent(in)  size 
)

Increase the size of a triplet list.

Parameters
[in,out]ih_thishandle to the triplet list to resize.
[in]sizeto resize to.

◆ settripletat_wrp()

pure subroutine, public tripletlistmodule_wrp::settripletat_wrp ( integer(kind=c_int), dimension(size_wrp), intent(inout)  ih_this,
integer(kind=c_int), intent(in)  index,
integer(kind=c_int), intent(in)  index_column,
integer(kind=c_int), intent(in)  index_row,
real(ntreal), intent(in)  point_value 
)

Set the value of a triplet at a particular index.

Parameters
[in,out]ih_thishandle to the triplet list to set.
[in]indexthe index at which to set the triplet.
[in]index_columnthe column value.
[in]index_rowthe row value.
[in]point_valuethe value at that point.

◆ sorttripletlist_wrp()

pure subroutine, public tripletlistmodule_wrp::sorttripletlist_wrp ( integer(kind=c_int), dimension(size_wrp), intent(in)  ih_this,
integer, intent(in)  matrix_columns,
integer(kind=c_int), dimension(size_wrp), intent(inout)  ih_sorted 
)

Sorts a triplet list by index values.

Parameters
[in]ih_thishandle to the triplet list to sort.
[in]matrix_columnsthis is the highest column value in the list.
[in,out]ih_sortedhandle to the sorted list.