The Star namespace is the main namespace through which all functionality of the STAR++ library is accessed. More...

Classes
class	Calculator
	The Calculator class provides the means to determine the result of an election. More...

class	Election
	The Election class represents a collection of candidates and ballots. More...

class	ElectionResult
	The ElectionResult class holds the outcome of an election. More...

class	ExpectedElectionResult
	The ExpectedElectionResult class compares the results of an election to a known outcome. More...

class	QualifierResult
	The QualifierResult class holds the outcome of a runoff qualifier. More...

struct	Rank
	The Rank struct represents a relative position for a given standing that can be occupied by multiple candidates. More...

struct	ReferenceError
	The ReferenceError struct is used to report errors while parsing election/results data in their reference formats. More...

class	Seat
	The Seat class contains the outcome for a specific seat in a given election. More...

Enumerations
enum class	ReferenceErrorType { NoError , CategoryConfig , BallotBox , ExpectedResult , CalcOptions }

Functions
ReferenceError	calculatorOptionsFromReferenceInput (Star::Calculator::Options &returnBuffer, const QString &calcOptionsPath)

ReferenceError	electionsFromReferenceInput (QList< Election > &returnBuffer, const QString &categoryConfigPath, const QString &ballotBoxPath)

ReferenceError	expectedResultsFromReferenceInput (QList< ExpectedElectionResult > &returnBuffer, const QString &resultSetPath)

Detailed Description

All library features are nested within this namespace in a similar vein as std with the C++ Standard Library.

Enumeration Type Documentation

strong

This enum describes the type of error that occurred while parsing reference format data.

Enumerator
NoError	No error occurred.
CategoryConfig	An error occurred while parsing a reference category config.
BallotBox	An error occurred while parsing a reference ballot box.
ExpectedResult	An error occurred while parsing a reference expected result set.

ReferenceError Star::calculatorOptionsFromReferenceInput	(	Star::Calculator::Options &	returnBuffer,
		const QString &	calcOptionsPath )

Parameters

[out]	returnBuffer	A list of calculator options, filled with the provided data.
[in]	calcOptionsPath	The path to the calculator option set file.

ReferenceError Star::electionsFromReferenceInput	(	QList< Election > &	returnBuffer,
		const QString &	categoryConfigPath,
		const QString &	ballotBoxPath )

Parameters

[out]	returnBuffer	A list of elections, prepared with the provided data.
[in]	categoryConfigPath	The path to the category config INI file.
[in]	ballotBoxPath	The path to the ballot box CSV file.

ReferenceError Star::expectedResultsFromReferenceInput	(	QList< ExpectedElectionResult > &	returnBuffer,
		const QString &	resultSetPath )

Parameters

[out]	returnBuffer	A list of expected election results, filled with the provided data.
[in]	resultSetPath	The path to the result set JSON file.