pm_sampleScale Module Reference

This module contains classes and procedures for scaling (i.e., multiplying) univariate or multivariate samples by arbitrary amounts along specific directions. More...

Data Types
interface	getScaled
	Generate a sample of shape (nsam), or (ndim, nsam) or (nsam, ndim) that is scaled by the specified input amount along the specified axis dim. More...
interface	setScaled
	Return a sample of shape (nsam), or (ndim, nsam) or (nsam, ndim) that is scaled by the specified input amount along the specified axis dim. More...
type	stdscale_type
	This is the derived type whose instances are meant to signify a sample scaling by an amount equal to the inverse of the sample standard deviation or an equivalent measure. More...

Variables
character(*, SK), parameter	MODULE_NAME = "@pm_sampleScale"
type(stdscale_type), parameter	stdscale = stdscale_type()

Detailed Description

This module contains classes and procedures for scaling (i.e., multiplying) univariate or multivariate samples by arbitrary amounts along specific directions.

Developer Remark:

While it is tempting to add generic interfaces for automatic scaling by the inverse of the standard deviation of the sample (in the absence of arbitrary amount argument), such interfaces were not added to this module for the following reasons:

1. Why should scaling by inverse of the standard deviation be the default behavior?
2. Even though scaling by inverse of the standard deviation is popular, its implementation as the default normalization in the generic interfaces of this module requires inclusion of sample weight and variance correction arguments, thus significantly complicating the interfaces of this module with little gain.
   

See also

pm_sampling
pm_sampleACT
pm_sampleCCF
pm_sampleCor
pm_sampleCov
pm_sampleConv
pm_sampleECDF
pm_sampleMean
pm_sampleNorm
pm_sampleQuan
pm_sampleScale
pm_sampleShift
pm_sampleWeight
pm_sampleAffinity
pm_sampleVar

Test:

test_pm_sampleScale

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Fatemeh Bagheri, Thursday 12:45 AM, August 20, 2021, Dallas, TX

Variable Documentation

MODULE_NAME

character(*, SK), parameter pm_sampleScale::MODULE_NAME = "@pm_sampleScale"

Definition at line 65 of file pm_sampleScale.F90.

stdscale

type(stdscale_type), parameter pm_sampleScale::stdscale = stdscale_type()

Definition at line 87 of file pm_sampleScale.F90.