mod_histogram::new_histogram Interface Reference

Interface for creating new histogram instance that contains either integer counts, or normalised real data. More...

Collaboration diagram for mod_histogram::new_histogram:

Public Member Functions
subroutine	new_int_histogram (this, length, unit_width, opt_initial_value)
	Create a new histogram instance. More...
subroutine	new_real_histogram (this, length, unit_width, opt_initial_value)
	Create a new real histogram instance for storing normalised data. More...

Detailed Description

Interface for creating new histogram instance that contains either integer counts, or normalised real data.

Member Function/Subroutine Documentation

new_int_histogram()

subroutine mod_histogram::new_histogram::new_int_histogram	(	type(type_int_hist), intent(inout)	this,
		integer, intent(in)	length,
		real(kind=8), intent(in)	unit_width,
		real(kind=8), intent(in), optional	opt_initial_value
	)

Create a new histogram instance.

Parameters

this	: histogram instance to be created
length	: number of elements in histogram array
unit_width	: unit value of one bin width
opt_initial_value	: unit value of beginning of first bin (zero if not set)

new_real_histogram()

subroutine mod_histogram::new_histogram::new_real_histogram	(	type(type_real_hist), intent(inout)	this,
		integer, intent(in)	length,
		real(kind=8), intent(in)	unit_width,
		real(kind=8), intent(in), optional	opt_initial_value
	)

Create a new real histogram instance for storing normalised data.

Parameters

this	: histogram instance to be created
length	: number of elements in histogram array
unit_width	: unit value of one bin width
opt_initial_value	: unit value of first bin (start from zero if not set)

---

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

• tools/mod_histogram.f90