ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
Partition_mod::Partition_type Type Reference

The Partition_type abstract class for Partition derived types. Partitions an input array Point(nd,np) with nd attributes and np observations (points). More...

Inheritance diagram for Partition_mod::Partition_type:
Collaboration diagram for Partition_mod::Partition_type:

Public Member Functions

procedure(getPartition_proc), deferred get
 
procedure(write_proc), deferred write
 

Public Attributes

integer(IK) nd
 
integer(IK) np
 See the interface of constructPartition(). More...
 
integer(IK) nc
 
integer(IK) nt
 See the interface of constructPartition(). More...
 
integer(IK) nemax
 See the interface of constructPartition(). More...
 
integer(IK) minSize
 See the interface of constructPartition(). More...
 
integer(IK) kmeansNumFailMax
 See the interface of constructPartition(). More...
 
integer(IK) numRecursiveCall
 The total number of recursive calls to the partitioning algorithm. More...
 
integer(IK) kmeansNumRecursionMax
 See the interface of constructPartition(). More...
 
integer(IK) convergenceFailureCount
 The number of times the partitioning algorithm has failed to converge. More...
 
integer(IK) kvolumeNumRecursionMax
 See the interface of constructPartition(). More...
 
logical(LK) biasCorrectionEnabled
 See the interface of constructPartition(). More...
 
logical(LK) mahalSqWeightEnabled
 A logical variable indicating whether if the input mahalSqWeight is nonzero. More...
 
logical(LK) stanEnabled
 See the interface of constructPartition(). More...
 
real(RK) nplog
 The natural logarithm of np, the initial number of points. More...
 
real(RK) kmeansRelTol
 See the interface of constructPartition(). More...
 
real(RK) logExpansion
 See the interface of constructPartition(). More...
 
real(RK) logShrinkage
 See the interface of constructPartition(). More...
 
real(RK) pointLogVolNormed
 The estimated volume of a single point based on the input value of parentLogVolNormed. More...
 
real(RK) parentLogVolNormed
 See the interface of constructPartition(). More...
 
real(RK) mahalSqWeightExponent
 See the interface of constructPartition(). More...
 
real(RK), dimension(:), allocatable BiasCorrectionScaleFactorSq
 The empirical corrections to the scale factors squared for different cluster sizes. More...
 
integer(IK), dimension(:), allocatable PointIndex
 An array of size (np) of indices such that the input Point(1:nd,Index(ip)) is saved at the output Point(1:nd,ip). More...
 
type(Err_type) Err
 An object of class Err_type containing information about error occurrence. More...
 
- Public Attributes inherited from Partition_mod::PartitionBase_type
integer(IK) ne
 The predicted optimal number of clusters identified in the input data. More...
 
integer(IK), dimension(:,:), allocatable Final
 An array of size (2,nemax) representing the (it,ic) indices of terminal partitions in Try component. More...
 
real(RK), dimension(:), allocatable VolNormedCDF
 The normalized cumulative volumes of the final partitions (to be used for selecting partitions uniformly randomly). More...
 
- Public Attributes inherited from Partition_mod::BaseProp_type
integer(IK), dimension(:), allocatable Size
 An array of size (nemax) representing the sizes of the corresponding bounding ellipsoids. More...
 
integer(IK), dimension(:), allocatable CumSumSize
 An array of size (0:nemax) containing the Cumulative sum of the array Size(). More...
 
integer(IK), dimension(:), allocatable Membership
 An array of size (np) representing the bounding-ellipsoid membership IDs of the corresponding data points. More...
 
integer(IK), dimension(:), allocatable EffectiveSize
 An array of size (nemax) indicating the likelihood of subclustering (0<<1 if successful, else 1<<2 if failed), enlargement (if < 0), being warranted. If further partitioning is warranted but fails, the likelihood will be negative. More...
 
real(RK), dimension(:), allocatable LogVolNormed
 An array of size (nemax) representing the log-volumes of the corresponding bounding ellipsoids. More...
 
real(RK), dimension(:,:,:), allocatable ChoLowCovUpp
 An array of size (nd,nd,nemax) representing the Cholesky lower triangle, diagonal, and covariance matrices of the bounding ellipsoids. More...
 
real(RK), dimension(:,:,:), allocatable InvCovMat
 An array of size (nd,nd,nemax) representing the full symmetric inverse covariance matrices of the bounding ellipsoids. More...
 
real(RK), dimension(:,:), allocatable ChoDia
 An array of size (nd,nemax) representing the Cholesky lower triangle, diagonal, and covariance matrices of the bounding ellipsoids. More...
 
real(RK), dimension(:,:), allocatable Center
 An array of size (nd,nemax) representing the centers of the bounding ellipsoids. More...
 

Detailed Description

The Partition_type abstract class for Partition derived types. Partitions an input array Point(nd,np) with nd attributes and np observations (points).

Definition at line 149 of file Partition_mod.F90.

Member Function/Subroutine Documentation

◆ get()

procedure(getPartition_proc), deferred Partition_mod::Partition_type::get

Definition at line 173 of file Partition_mod.F90.

◆ write()

procedure(write_proc), deferred Partition_mod::Partition_type::write

Definition at line 174 of file Partition_mod.F90.

Member Data Documentation

◆ biasCorrectionEnabled

logical(LK) Partition_mod::Partition_type::biasCorrectionEnabled

See the interface of constructPartition().

Definition at line 159 of file Partition_mod.F90.

◆ BiasCorrectionScaleFactorSq

real(RK), dimension(:), allocatable Partition_mod::Partition_type::BiasCorrectionScaleFactorSq

The empirical corrections to the scale factors squared for different cluster sizes.

Definition at line 169 of file Partition_mod.F90.

◆ convergenceFailureCount

integer(IK) Partition_mod::Partition_type::convergenceFailureCount

The number of times the partitioning algorithm has failed to converge.

Definition at line 157 of file Partition_mod.F90.

◆ Err

type(Err_type) Partition_mod::Partition_type::Err

An object of class Err_type containing information about error occurrence.

Definition at line 171 of file Partition_mod.F90.

◆ kmeansNumFailMax

integer(IK) Partition_mod::Partition_type::kmeansNumFailMax

See the interface of constructPartition().

Definition at line 154 of file Partition_mod.F90.

◆ kmeansNumRecursionMax

integer(IK) Partition_mod::Partition_type::kmeansNumRecursionMax

See the interface of constructPartition().

Definition at line 156 of file Partition_mod.F90.

◆ kmeansRelTol

real(RK) Partition_mod::Partition_type::kmeansRelTol

See the interface of constructPartition().

Definition at line 163 of file Partition_mod.F90.

◆ kvolumeNumRecursionMax

integer(IK) Partition_mod::Partition_type::kvolumeNumRecursionMax

See the interface of constructPartition().

Definition at line 158 of file Partition_mod.F90.

◆ logExpansion

real(RK) Partition_mod::Partition_type::logExpansion

See the interface of constructPartition().

Definition at line 164 of file Partition_mod.F90.

◆ logShrinkage

real(RK) Partition_mod::Partition_type::logShrinkage

See the interface of constructPartition().

Definition at line 165 of file Partition_mod.F90.

◆ mahalSqWeightEnabled

logical(LK) Partition_mod::Partition_type::mahalSqWeightEnabled

A logical variable indicating whether if the input mahalSqWeight is nonzero.

Definition at line 160 of file Partition_mod.F90.

◆ mahalSqWeightExponent

real(RK) Partition_mod::Partition_type::mahalSqWeightExponent

See the interface of constructPartition().

Definition at line 168 of file Partition_mod.F90.

◆ minSize

integer(IK) Partition_mod::Partition_type::minSize

See the interface of constructPartition().

Definition at line 153 of file Partition_mod.F90.

◆ nc

integer(IK) Partition_mod::Partition_type::nc

Definition at line 151 of file Partition_mod.F90.

◆ nd

integer(IK) Partition_mod::Partition_type::nd

Definition at line 150 of file Partition_mod.F90.

◆ nemax

integer(IK) Partition_mod::Partition_type::nemax

See the interface of constructPartition().

Definition at line 152 of file Partition_mod.F90.

◆ np

integer(IK) Partition_mod::Partition_type::np

See the interface of constructPartition().

Definition at line 150 of file Partition_mod.F90.

◆ nplog

real(RK) Partition_mod::Partition_type::nplog

The natural logarithm of np, the initial number of points.

Definition at line 162 of file Partition_mod.F90.

◆ nt

integer(IK) Partition_mod::Partition_type::nt

See the interface of constructPartition().

Definition at line 151 of file Partition_mod.F90.

◆ numRecursiveCall

integer(IK) Partition_mod::Partition_type::numRecursiveCall

The total number of recursive calls to the partitioning algorithm.

Definition at line 155 of file Partition_mod.F90.

◆ parentLogVolNormed

real(RK) Partition_mod::Partition_type::parentLogVolNormed

See the interface of constructPartition().

Definition at line 167 of file Partition_mod.F90.

◆ PointIndex

integer(IK), dimension(:), allocatable Partition_mod::Partition_type::PointIndex

An array of size (np) of indices such that the input Point(1:nd,Index(ip)) is saved at the output Point(1:nd,ip).

Definition at line 170 of file Partition_mod.F90.

◆ pointLogVolNormed

real(RK) Partition_mod::Partition_type::pointLogVolNormed

The estimated volume of a single point based on the input value of parentLogVolNormed.

Definition at line 166 of file Partition_mod.F90.

◆ stanEnabled

logical(LK) Partition_mod::Partition_type::stanEnabled

See the interface of constructPartition().

Definition at line 161 of file Partition_mod.F90.


The documentation for this type was generated from the following file: