StephenAshley.Biostatistics.Rank Struct Reference

A struct designed to hold items that have been ranked. More...

List of all members.

Public Member Functions
	Rank (Int32 iGrp, NUMBER decA, NUMBER decRnk)
	Constructor for a Rank object.
Static Public Member Functions
static Int32	AdjustTies (ref List< Rank > lstRanks)
	Adjust the ranks of Rank objects when multiple objects have the same value.
static int	CompareRanks (Rank x, Rank y)
	Compares one Rank to another Rank.
static int	CompareRanksByAbsoluteValues (Rank x, Rank y)
	Compares one Rank to another Rank based on the absolute value of their values.
Public Attributes
Int32	iGroup
	The Group to which the item belongs.
NUMBER	decValue
	The value of the item.
NUMBER	decRank
	The rank of the item.

---

Detailed Description

A struct designed to hold items that have been ranked.

Definition at line 12 of file Rank.cs.

---

Constructor & Destructor Documentation

StephenAshley.Biostatistics.Rank.Rank	(	Int32	iGrp,
		NUMBER	decA,
		NUMBER	decRnk
	)

Constructor for a Rank object.

Parameters:

	iGrp	The Group to which the item belongs.
	decA	The value of the item.
	decRnk	The rank of the item.

Definition at line 21 of file Rank.cs.

---

Member Function Documentation

static Int32 StephenAshley.Biostatistics.Rank.AdjustTies

(

ref List< Rank >

lstRanks

)

[static]

Adjust the ranks of Rank objects when multiple objects have the same value.

Parameters:

lstRanks

The list of Rank objects.

Returns:

The sum of the number of tied ranks in each set of ties.

stanton a. glantz, primer of biostatistics (6th ed. 2005).

Definition at line 51 of file Rank.cs.

static int StephenAshley.Biostatistics.Rank.CompareRanks	(	Rank	x,
		Rank	y
	)			[static]

Compares one Rank to another Rank.

Parameters:

	x	The first Rank.
	y	The second Rank.

Returns:

A negative integer if the first Rank is less than the seond Rank, a zero if the first Rank is equal to the second Rank, or a positive integer if the first Rank is greater than the second Rank.

Definition at line 100 of file Rank.cs.

static int StephenAshley.Biostatistics.Rank.CompareRanksByAbsoluteValues	(	Rank	x,
		Rank	y
	)			[static]

Compares one Rank to another Rank based on the absolute value of their values.

Parameters:

	x	The first Rank.
	y	The second Rank.

Returns:

A negative integer if the first Rank is less than the seond Rank, a zero if the first Rank is equal to the second Rank, or a positive integer if the first Rank is greater than the second Rank.

Definition at line 115 of file Rank.cs.

---

Member Data Documentation

NUMBER StephenAshley.Biostatistics.Rank.decRank

The rank of the item.

Definition at line 42 of file Rank.cs.

NUMBER StephenAshley.Biostatistics.Rank.decValue

The value of the item.

Definition at line 37 of file Rank.cs.

Int32 StephenAshley.Biostatistics.Rank.iGroup

The Group to which the item belongs.

Definition at line 32 of file Rank.cs.

---

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

• C:/Documents and Settings/Stephen/Desktop/Biostatistics Library and Program/Biostatistics/Rank.cs