David Alm: Automated Syncronization with Documentation

2013-06-26T00:29:26Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:29, 26 June 2013
Line 5:		Line 5:
	</span></b>		</span></b>

−	'''Package:''' [[Package ~~SignalLabBasicPkg~~\|~~SignalLabBasicPkg~~]]	+	'''Package:''' [[Package Mitov.BasicLab\|Mitov.BasicLab]]

	'''Unit:''' [[Unit SLSimpleDataBuffer\|SLSimpleDataBuffer]]		'''Unit:''' [[Unit SLSimpleDataBuffer\|SLSimpleDataBuffer]]

David Alm: Automated Syncronization with Documentation

2012-10-18T16:52:38Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]

'''Unit:''' [[Unit SLSimpleDataBuffer|SLSimpleDataBuffer]]

'''Inherits:''' [[Interface SLSimpleDataBuffer.ISLLinearDataBuffer|ISLLinearDataBuffer]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' ISLRealBuffer = '''interface'''( [[Interface SLSimpleDataBuffer.ISLLinearDataBuffer|ISLLinearDataBuffer]] )
</code>
== Summary ==
Real data buffer interface.

== Description ==
This is the Real data buffer interface.

== Properties ==
*[[Property SLSimpleDataBuffer.ISLRealBuffer.Items|Items]] - Access to individual Real(double) item of the buffer.
*[[Property SLSimpleDataBuffer.ISLRealBuffer.Min|Min]] - Returns the min value in the buffer.
*[[Property SLSimpleDataBuffer.ISLRealBuffer.Max|Max]] - Returns the max value in the buffer.

== Methods ==
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Read() : PReal|function Read() : PReal]] - Returns read only pointer to the buffer data.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Write() : PReal|function Write() : PReal]] - Returns write pointer to the buffer data.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Modify() : PReal|function Modify() : PReal]] - Returns read and write pointer to the buffer data.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetItem(Integer) : Real|function GetItem(Index : Integer) : Real]]
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.SetItem(Integer;Real)|procedure SetItem(Index : Integer; Value : Real)]]
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.VectorJaehne(Real)|procedure VectorJaehne(AMagnitude : Real)]] - Creates a test Jaehne data in the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Add(ISLRealBuffer)|procedure Add(Right : ISLRealBuffer)]] - Adds the elements of the buffer to the corresponding elements of another buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Subtract(ISLRealBuffer)|procedure Subtract(Right : ISLRealBuffer)]] - Subtracts the elements of the buffer by the corresponding elements of another buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Multiply(ISLRealBuffer)|procedure Multiply(Right : ISLRealBuffer)]] - Multiplies the elements of the buffer by the corresponding elements of another buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Divide(ISLRealBuffer)|procedure Divide(Right : ISLRealBuffer)]] - Divides the elements of the buffer by the corresponding elements of another buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.SetValue(Real)|procedure SetValue(AValue : Real)]] - Sets all the elements of the buffer to a certain value.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.AddValue(Real)|procedure AddValue(AValue : Real)]] - Adds a double value to each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.SubtractValue(Real)|procedure SubtractValue(AValue : Real)]] - Subtracts a double value from each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.MultiplyValue(Real)|procedure MultiplyValue(AValue : Real)]] - Multiplies a real value to each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.DivideValue(Real)|procedure DivideValue(AValue : Real)]] - Divides each element of the buffer data by a value.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Zero()|procedure Zero()]] - Sets all the elements of the buffer to 0.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.ToInt(PInteger;Boolean)|procedure ToInt(OutBuffer : PInteger; ARound : Boolean)]] - Copies the content of the buffer to memory location as Integers.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.ToShort(PSmallInt;Boolean)|procedure ToShort(OutBuffer : PSmallInt; ARound : Boolean)]] - Copies the content of the buffer to memory location as SmallInts.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.ToSingle(PSingle)|procedure ToSingle(OutBuffer : PSingle)]] - Copies the content of the buffer to memory location as Singles(floats).
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.FromInt(PInteger)|procedure FromInt(InBuffer : PInteger)]] - Copies the content of memory location to the buffer as Integers.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.FromShort(PSmallInt)|procedure FromShort(InBuffer : PSmallInt)]] - Copies the content of memory location to the buffer as SmallInts.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.FromSingle(PSingle)|procedure FromSingle(InBuffer : PSingle)]] - Copies the content of memory location to the buffer as Singles(floats).
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.NormalizeFrom(ISLRealBuffer;Real;Real)|procedure NormalizeFrom(Src : ISLRealBuffer; Offset : Real; Factor : Real)]] - Normalizes the elements of another buffer using offset and division operations, and assigns the result to this buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Normalize(Real;Real)|procedure Normalize(Offset : Real; Factor : Real)]] - Normalizes the elements of the buffer using offset and division operations.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Dot(ISLRealBuffer) : Real|function Dot(Right : ISLRealBuffer) : Real]] - Computes the dot product of two buffers.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Threshold(Real;TSLThresholdType)|procedure Threshold(AThreshold : Real; AType : TSLThresholdType)]] - Performs the threshold operation on the elements of a vector by limiting the element values by Level.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.ThresholdFrom(ISLRealBuffer;Real;TSLThresholdType)|procedure ThresholdFrom(Src : ISLRealBuffer; AThreshold : Real; AType : TSLThresholdType)]] - Performs the threshold operation on the elements of another vector by limiting the element values by Level, and stoes the results in the current vector.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Sqr()|procedure Sqr()]] - Computes a square of each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.SqrFrom(ISLRealBuffer)|procedure SqrFrom(Src : ISLRealBuffer)]] - Computes a square of each element of another buffer, and assigns the result to this buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Sqrt()|procedure Sqrt()]] - Computes a square root of each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.SqrtFrom(ISLRealBuffer)|procedure SqrtFrom(Src : ISLRealBuffer)]] - Computes a square root of each element of another buffer, and assigns the result to this buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.AutoCorr(ISLRealBuffer;TSLAutoCorrType)|procedure AutoCorr(Src : ISLRealBuffer; AType : TSLAutoCorrType)]] - Estimates normal, biased, and unbiased auto-correlation of a vector.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.CrossCorr(ISLRealBuffer;ISLRealBuffer;Integer)|procedure CrossCorr(Src1 : ISLRealBuffer; Src2 : ISLRealBuffer; LoLag : Integer)]] - Estimates the cross-correlation of two buffers. and stores the result in the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Abs()|procedure Abs()]] - Converts each element of the buffer to its absolute value.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.AbsFrom(ISLRealBuffer)|procedure AbsFrom(Src : ISLRealBuffer)]] - Assigns each element of the buffer with the absolute value of the corresponding element of another buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Exp()|procedure Exp()]] - Computes e to the powerof each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.ExpFrom(ISLRealBuffer)|procedure ExpFrom(Src : ISLRealBuffer)]] - Computes e to the powerof each element of another buffer and store the result in the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Ln()|procedure Ln()]] - Computes the natural logarithm of each element of the buffer.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.LnFrom(ISLRealBuffer)|procedure LnFrom(Src : ISLRealBuffer)]] - Computes the natural logarithm of each element of another buffer, and assigns the result to this buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Mean() : Real|function Mean() : Real]] - Computes the mean value of the buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.StdDev() : Real|function StdDev() : Real]] - Computes the standard deviation value of a vector.
*[[Method procedure SLSimpleDataBuffer.ISLRealBuffer.Convolve(ISLRealBuffer;ISLRealBuffer)|procedure Convolve(Src : ISLRealBuffer; H : ISLRealBuffer)]] - Performs finite, linear convolution of the elements of the buffer and the elements of another buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.Norm(ISLRealBuffer;TSLNormType) : Real|function Norm(Src : ISLRealBuffer; AType : TSLNormType) : Real]] - Computes the C, L1, or L2 norm of the buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMinValue() : Real|function GetMinValue() : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMaxValue() : Real|function GetMaxValue() : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMinIndex(Integer) : Real|function GetMinIndex(var AIndex : Integer) : Real]] - Returns the index of the smallest sample in the buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMaxIndex(Integer) : Real|function GetMaxIndex(var AIndex : Integer) : Real]] - Returns the index of the biggest sample in the buffer.
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMin(Integer;Integer) : Real|function GetMin(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMax(Integer;Integer) : Real|function GetMax(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMinRestricted(Integer;Integer) : Real|function GetMinRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.GetMaxRestricted(Integer;Integer) : Real|function GetMaxRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.ISLRealBuffer.IsEqualToValue(Real) : Boolean|function IsEqualToValue(AValue : Real) : Boolean]] - Checks if all the elements in the buffer are equal to a value.

[[Category:Interfaces]]

Interface SLSimpleDataBuffer.ISLRealBuffer - Revision history

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation