Wrapper to generate, save and load xml files. More...

#include <DataGenerator.h>

Public Member Functions
	DataGenerator (Config &config)

void	datasetGenerator (int nb_criteria, int nb_alternative, int nb_categories, std::string datasetName="", bool overwrite=1, unsigned long int seed=0)

void	modelGenerator (int nb_criteria, int nb_categories, std::string modelName, bool overwrite=1, unsigned long int seed=0)

void	saveDataset (std::string fileName, AlternativesPerformance altPerf, int nb_categories, bool overwrite=1, std::string datasetName="")

AlternativesPerformance	loadDataset (std::string fileName)

void	saveModel (std::string fileName, float lambda, Criteria criteria, PerformanceTable pt, bool overwrite=1, std::string modelName="")

std::tuple< float, Criteria, PerformanceTable >	loadModel (std::string fileName)

pugi::xml_document	openXmlFile (std::string filename)

std::string	getXmlFileType (std::string fileName)

int	getNumberOfCriteria (std::string fileName)

int	getNumberOfCategories (std::string fileName)

float	getThresholdValue (std::string fileName)

int	getNumberOfAlternatives (std::string fileName)

std::vector< Perf >	getAlternativePerformance (std::string fileName, std::string alt_id)

std::vector< std::string >	getAlternativeIds (std::string fileName)

std::vector< std::string >	getCriteriaIds (std::string fileName)

Criterion	getCriterion (std::string fileName, std::string crit_id)

int	getAlternativeAssignment (std::string fileName, std::string alt_id)

std::vector< float >	getCriterionCategoryLimits (std::string fileName, std::string crit_id)

bool	checkDataCompatability (std::string fileName)

Detailed Description

Wrapper to generate, save and load xml files.

The DataGenerator is a utility class that is the bridge between the datastructure of this project and the corresponding xml files used to store a dataset or a model.

Member Function Documentation

◆ checkDataCompatability()

bool DataGenerator::checkDataCompatability ( std::string fileName )

This method checks if the dataset used for our profile initialisation is compatible in our framework. Essentially, it checks that at least one alternative is assigned to each category of our problem.

Parameters

fileName dataset filename

Returns: bool

◆ datasetGenerator()

void DataGenerator::datasetGenerator	(	int	nb_criteria,
		int	nb_alternative,
		int	nb_categories,
		std::string	datasetName = `""`,
		bool	overwrite = `1`,
		unsigned long int	seed = `0`
	)

Generate a random dataset and puts it in a xml file

Parameters

nb_criteria	number of criteria
nb_alternative	number of alternatives
nb_categories	number of categories
datasetName	name of that dataset
overwrite	bool that refers to if we want to overwrite file
seed	seed to control random generation

Returns: a saved file of the name datasetName.xml in data/ or default generated name

◆ getAlternativeAssignment()

int DataGenerator::getAlternativeAssignment	(	std::string	fileName,
		std::string	alt_id
	)

Get alternative category assignment

Parameters

fileName	filename
alt_id	Criterion id

◆ getAlternativeIds()

std::vector<std::string> DataGenerator::getAlternativeIds ( std::string fileName )

Get all of alternative ids if they exists

Parameters

fileName filename

◆ getAlternativePerformance()

std::vector<Perf> DataGenerator::getAlternativePerformance	(	std::string	fileName,
		std::string	alt_id
	)

Get performance of alternative

Parameters

fileName	filename
alt_id	Alternative id

◆ getCriteriaIds()

std::vector<std::string> DataGenerator::getCriteriaIds ( std::string fileName )

Get all of criteria ids

Parameters

fileName filename

◆ getCriterion()

Criterion DataGenerator::getCriterion	(	std::string	fileName,
		std::string	crit_id
	)

Get weight for one specific criterion id

Parameters

fileName	filename
crit_id	Criterion id

◆ getCriterionCategoryLimits()

std::vector<float> DataGenerator::getCriterionCategoryLimits	(	std::string	fileName,
		std::string	crit_id
	)

Get alternative category assignment

Parameters

fileName	filename
crit_id	Criterion id

◆ getNumberOfAlternatives()

int DataGenerator::getNumberOfAlternatives ( std::string fileName )

Get number of alternatives found in dataset xml file if it exists

Parameters

fileName filename

◆ getNumberOfCategories()

int DataGenerator::getNumberOfCategories ( std::string fileName )

Get number of categories found in xml file

Parameters

fileName filename

◆ getNumberOfCriteria()

int DataGenerator::getNumberOfCriteria ( std::string fileName )

Get number of criterias found in xml file

Parameters

fileName filename

◆ getThresholdValue()

float DataGenerator::getThresholdValue ( std::string fileName )

Get lambda threshold value found in xml file if it exists

Parameters

fileName filename

◆ getXmlFileType()

std::string DataGenerator::getXmlFileType ( std::string fileName )

Gets the xml file type

Parameters

fileName filename

Returns: "model" for model xml file types or "dataset" for data xml

◆ loadDataset()

AlternativesPerformance DataGenerator::loadDataset ( std::string fileName )

Get dataset data from xml file

Parameters

fileName filename

Returns: AlternativesPerformance object in order to use MRSort model

◆ loadModel()

std::tuple<float, Criteria, PerformanceTable> DataGenerator::loadModel ( std::string fileName )

Get model data from xml file

Parameters

fileName filename

Returns: tuple object to use algorithms

◆ modelGenerator()

void DataGenerator::modelGenerator	(	int	nb_criteria,
		int	nb_categories,
		std::string	modelName,
		bool	overwrite = `1`,
		unsigned long int	seed = `0`
	)

Generate a random model and puts it in a xml file

Parameters

nb_criteria	number of criteria
nb_categories	number of categories
modelName	name of that model
overwrite	bool that refers to if we want to overwrite file
seed	seed to control random generation

Returns: a saved file of the name nametName.xml in data/ or default generated name

◆ openXmlFile()

pugi::xml_document DataGenerator::openXmlFile ( std::string filename )

Get an xml_document type for preocessing the xml files

Parameters

fileName filename

Returns: pugi::xml_document object that hold info on the xml filename file

◆ saveDataset()

void DataGenerator::saveDataset	(	std::string	fileName,
		AlternativesPerformance	altPerf,
		int	nb_categories,
		bool	overwrite = `1`,
		std::string	datasetName = `""`
	)

Save dataset data in xml file name filename

Parameters

fileName	filename
altPerf	Alternative Peformance type
nb_categories	number of categories
overwrite	overwrite potentiel filename if it exists
datasetName	dataset name given in xml file

Returns: save file in xml format

◆ saveModel()

void DataGenerator::saveModel	(	std::string	fileName,
		float	lambda,
		Criteria	criteria,
		PerformanceTable	pt,
		bool	overwrite = `1`,
		std::string	modelName = `""`
	)

Save model data in xml file name filename

Parameters

fileName	filename
lambda	threshold
pt	profile Performance table
overwrite	do i want to overwrite a file if it has the same "fileName"
modelName	model name given in the xml

Returns: save file in xml format

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

/Users/ThomasVindard 1/Desktop/3A/Projet/fastPL/include/types/DataGenerator.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ checkDataCompatability()

◆ datasetGenerator()

◆ getAlternativeAssignment()

◆ getAlternativeIds()

◆ getAlternativePerformance()

◆ getCriteriaIds()

◆ getCriterion()

◆ getCriterionCategoryLimits()

◆ getNumberOfAlternatives()

◆ getNumberOfCategories()

◆ getNumberOfCriteria()

◆ getThresholdValue()

◆ getXmlFileType()

◆ loadDataset()

◆ loadModel()

◆ modelGenerator()

◆ openXmlFile()

◆ saveDataset()

◆ saveModel()