Vector.Sech Method

Overload List

#	Signature	Description
1	TMtxVec Sech	Hyperbolic secant.
	└ indexed: TMtxVec Sech(Int32 Index, Int32 Len)
2	TMtxVec Sech(TMtxVec X)	Calculate the hyperbolic secant for all X object elements.
	└ indexed: TMtxVec Sech(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Overload 1: TMtxVec Sech

Hyperbolic secant.

Result: stored in self (calling object), returns self for chaining

Remarks:

Calculate the hyperbolic secant of all caling object elements in-place.

Examples

Vector a = new Vector();
a.SetIt(new double[] { 0.0, 0.5, 1.0, 2.0 });
a.Sech();
Vector expected = new Vector();
expected.SetIt(new double[] { 1.0, 0.886818883970074, 0.648054273663885, 0.26580222883408 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.Sech: mismatch");

See Also: Vector.ArcSech, Vector.Csch

Indexed: TMtxVec Sech(Int32 Index, Int32 Len)

Calculate the hyperbolic secant for calling object elements [Index]...[Index+Len-1] in-place.

#	Name	Type	Description
1	Index	Int32	start index
2	Len	Int32	element count

Result: stored in self (calling object), returns self for chaining

Remarks:

An exception is raised if array borders are overrun.

Overload 2: TMtxVec Sech(TMtxVec X)

Calculate the hyperbolic secant for all X object elements.

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

Result: stored in self (calling object), returns self for chaining

Remarks:

Store the results in the calling object. Size and Dew.Math.Vector.Complex properties of calling object are adjusted automatically.

Examples

Vector a = new Vector();
Vector x = new Vector();
x.SetIt(new double[] { 0.0, 0.5, 1.0, 2.0 });
a.Sech(x);
Vector expected = new Vector();
expected.SetIt(new double[] { 1.0, 0.886818883970074, 0.648054273663885, 0.26580222883408 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.Sech: mismatch");

Indexed: TMtxVec Sech(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Calculate the hyperbolic secant for X object elements [XIndex]..[XIndex+Len-1].

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx
2	XIndex	Int32	X start index
3	Index	Int32	start index
4	Len	Int32	element count

Result: stored in self (calling object), returns self for chaining

Remarks:

The results are stored in calling object elements [Index]..[Index+Len-1]. Size and Dew.Math.Vector.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun.