StephenAshley.Biostatistics.GroupsCollection Class Reference

An list of Group objects. More...

Inheritance diagram for StephenAshley.Biostatistics.GroupsCollection:

List of all members.

Public Member Functions

GroupsCollection ()

Constructs an empty GroupsCollection.

GroupsCollection (List< Group > lstGroups)

Creates a GroupsCollection from a List of Groups.

virtual void Add (Group group)

Adds a Group to the GroupsCollection.

virtual void AddRange (List< Group > groups)

Adds a list of Group objects to the GroupsCollection.

IEnumerator GetEnumerator ()

Returns an enumerator that iterates through the GroupsCollection.

Int32 k ()

Returns the number of elements actually contained in the GroupsCollection.

Int32 nTotal ()

Returns the total number of elements in all the Group objects in the GroupsCollection.

NUMBER MeanTotal ()

Returns the mean of all the members of all the Group objects in the GroupsCollection.

NUMBER SumTotal ()

Returns the sum of all the members of all the Group objects in the GroupsCollection.

Protected Attributes

Group[] groupsArray

Contains the Group objects that comprise the GroupsCollection.

Properties

Group this [int index] [get, set]

Gets or sets the value at the specified index.

Detailed Description

An list of Group objects.

Definition at line 13 of file GroupsCollection.cs.

Constructor & Destructor Documentation

StephenAshley.Biostatistics.GroupsCollection.GroupsCollection ( )

Constructs an empty GroupsCollection.

Definition at line 31 of file GroupsCollection.cs.

StephenAshley.Biostatistics.GroupsCollection.GroupsCollection ( List< Group > lstGroups )

Creates a GroupsCollection from a List of Groups.

Parameters:

lstGroups

The Groups.

Exceptions:

Biostatistics

lstGroups is null.

Definition at line 52 of file GroupsCollection.cs.

Member Function Documentation

virtual void StephenAshley.Biostatistics.GroupsCollection.Add ( Group group ) [virtual]

Adds a Group to the GroupsCollection.

Parameters:

group

A Group.

Exceptions:

BiostatisticsException

group is a null reference.

Definition at line 71 of file GroupsCollection.cs.

virtual void StephenAshley.Biostatistics.GroupsCollection.AddRange ( List< Group > groups ) [virtual]

Adds a list of Group objects to the GroupsCollection.

Parameters:

groups

A list of Group objects.

Exceptions:

BiostatisticsException

groups is null.

Reimplemented in StephenAshley.Biostatistics.ANOVAGroupsCollection, StephenAshley.Biostatistics.CorrelationRegressionGroupsCollection, StephenAshley.Biostatistics.MannWhitneyGroupsCollection, StephenAshley.Biostatistics.PairedT_TestGroupsCollection, StephenAshley.Biostatistics.RepeatedMeasuresANOVAGroupsCollection, StephenAshley.Biostatistics.SpearmanRankSumGroupsCollection, and StephenAshley.Biostatistics.T_TestGroupsCollection.

Definition at line 98 of file GroupsCollection.cs.

IEnumerator StephenAshley.Biostatistics.GroupsCollection.GetEnumerator ( )

Returns an enumerator that iterates through the GroupsCollection.

Returns:: The enumerator.

Definition at line 116 of file GroupsCollection.cs.

Int32 StephenAshley.Biostatistics.GroupsCollection.k ( )

Returns the number of elements actually contained in the GroupsCollection.

Returns:: The number of Group objects actually contained in the GroupsCollection.

Definition at line 127 of file GroupsCollection.cs.

NUMBER StephenAshley.Biostatistics.GroupsCollection.MeanTotal ( )

Returns the mean of all the members of all the Group objects in the GroupsCollection.

Returns:: The mean.

Exceptions:

BiostatisticsException

the GroupsCollection contains no elements.

Definition at line 153 of file GroupsCollection.cs.

Int32 StephenAshley.Biostatistics.GroupsCollection.nTotal ( )

Returns the total number of elements in all the Group objects in the GroupsCollection.

Returns:: The total.

Definition at line 141 of file GroupsCollection.cs.

NUMBER StephenAshley.Biostatistics.GroupsCollection.SumTotal ( )

Returns the sum of all the members of all the Group objects in the GroupsCollection.

Returns:: The sum.

Definition at line 160 of file GroupsCollection.cs.

Member Data Documentation

Group [] StephenAshley.Biostatistics.GroupsCollection.groupsArray [protected]

Contains the Group objects that comprise the GroupsCollection.

Definition at line 19 of file GroupsCollection.cs.

Property Documentation

Group StephenAshley.Biostatistics.GroupsCollection.this[int index] [get, set]

Gets or sets the value at the specified index.

Parameters:

index

The zero-based index of the element to get or set.

Returns:: The value at the specified index.

Exceptions:

BiostatisticsException

Parameter index is less than 0, or index is equal to or greater than n.

Reimplemented in StephenAshley.Biostatistics.ANOVAGroupsCollection.

Definition at line 172 of file GroupsCollection.cs.

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

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


Public Member Functions
	GroupsCollection ()
	Constructs an empty GroupsCollection.
	GroupsCollection (List< Group > lstGroups)
	Creates a GroupsCollection from a List of Groups.
virtual void	Add (Group group)
	Adds a Group to the GroupsCollection.
virtual void	AddRange (List< Group > groups)
	Adds a list of Group objects to the GroupsCollection.
IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through the GroupsCollection.
Int32	k ()
	Returns the number of elements actually contained in the GroupsCollection.
Int32	nTotal ()
	Returns the total number of elements in all the Group objects in the GroupsCollection.
NUMBER	MeanTotal ()
	Returns the mean of all the members of all the Group objects in the GroupsCollection.
NUMBER	SumTotal ()
	Returns the sum of all the members of all the Group objects in the GroupsCollection.
Protected Attributes
Group[]	groupsArray
	Contains the Group objects that comprise the GroupsCollection.
Properties
Group	this [int index] `[get, set]`
	Gets or sets the value at the specified index.