ScipParaSolution Class Reference

#include <scipParaSolution.h>

Inheritance diagram for ScipParaSolution:

Public Member Functions
	ScipParaSolution ()
	ScipParaSolution (ScipParaSolver *solver, SCIP_Real objval, int inNvars, SCIP_VAR **vars, SCIP_Real *vals)
	ScipParaSolution (double inObjectiveFunctionValue, int inNVars, int *inIndicesAmongSolvers, SCIP_Real *inValues)
virtual	~ScipParaSolution ()
double	getObjectiveFunctionValue ()
void	setObjectiveFuntionValue (SCIP_Real val)
int	getNVars ()
int	indexAmongSolvers (int index)
SCIP_Real *	getValues ()
void	setValue (int i, SCIP_Real val)
void	write (gzstream::ogzstream &out)
bool	read (UG::ParaComm *comm, gzstream::igzstream &in)
const std::string	toString ()
Public Member Functions inherited from BbParaSolution
	BbParaSolution ()
	DO NOT HAVE DATA MEMBER!! More...
virtual	~BbParaSolution ()
	destructor More...
virtual double	getObjectiveFunctionValue ()=0
	get objective function value More...
virtual double	getCutOffValue ()
	get cutoff value More...
Public Member Functions inherited from ParaSolution
	ParaSolution ()
	DO NOT HAVE DATA MEMBER!! More...
virtual	~ParaSolution ()
	destructor More...
virtual double	getObjectiveFunctionValue ()=0
	get objective function value More...
virtual ParaSolution *	clone (ParaComm *comm)=0
	create clone of this object More...
virtual void	bcast (ParaComm *comm, int root)=0
	broadcast solution data More...
virtual void	send (ParaComm *comm, int destination)=0
	send solution data More...
virtual void	receive (ParaComm *comm, int source)=0
	receive solution data More...
virtual void	write (gzstream::ogzstream &out)=0
	function to write ParaSolution object to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	function to read ParaSolution object from checkpoint file More...
virtual const std::string	toString ()
	stringfy ParaSolution object More...

Protected Attributes
double	objectiveFunctionValue
int	nVars
int *	indicesAmongSolvers
SCIP_Real *	values

Detailed Description

ScipParaSolution class

Definition at line 49 of file scipParaSolution.h.

Constructor & Destructor Documentation

ScipParaSolution() [1/3]

ScipParaSolution

(

)

constructor

Definition at line 58 of file scipParaSolution.h.

ScipParaSolution() [2/3]

ScipParaSolution	(	ScipParaSolver *	solver,
		SCIP_Real	objval,
		int	inNvars,
		SCIP_VAR **	vars,
		SCIP_Real *	vals
	)

Definition at line 64 of file scipParaSolution.h.

References ScipParaSolver::getOriginalIndex(), ScipParaSolution::indicesAmongSolvers, ScipParaSolver::isOriginalIndeciesMap(), ScipParaSolution::nVars, ScipParaSolution::objectiveFunctionValue, and ScipParaSolution::values.

ScipParaSolution() [3/3]

ScipParaSolution	(	double	inObjectiveFunctionValue,
		int	inNVars,
		int *	inIndicesAmongSolvers,
		SCIP_Real *	inValues
	)

Parameters

inObjectiveFunctionValue	objective function value
inNVars	number of variables
inIndicesAmongSolvers	array of variable indices ( probindex )
inValues	array of bounds which the branchings

Definition at line 106 of file scipParaSolution.h.

References ScipParaSolution::indicesAmongSolvers, ScipParaSolution::nVars, and ScipParaSolution::values.

~ScipParaSolution()

virtual ~ScipParaSolution ( )

virtual

destructor

Definition at line 126 of file scipParaSolution.h.

References ScipParaSolution::indicesAmongSolvers, and ScipParaSolution::values.

Member Function Documentation

getNVars()

int getNVars

(

)

get number of variables

Definition at line 140 of file scipParaSolution.h.

References ScipParaSolution::nVars.

Referenced by ScipParaInstance::getSolValuesForOriginalProblem(), ScipParaInitiator::outputFinalSolverStatistics(), ScipParaSolver::tryNewSolution(), and ScipParaInitiator::tryToSetIncumbentSolution().

getObjectiveFunctionValue()

double getObjectiveFunctionValue ( )

virtual

get objective function value

Implements BbParaSolution.

Definition at line 134 of file scipParaSolution.h.

References ScipParaSolution::objectiveFunctionValue.

Referenced by ScipParaInitiator::getAbsgap(), ScipParaInitiator::getGap(), ScipParaInitiator::outputFinalSolverStatistics(), ScipParaInitiator::readSolutionFromCheckpointFile(), ScipParaInitiator::sendSolverInitializationMessage(), and ScipParaInitiator::tryToSetIncumbentSolution().

getValues()

SCIP_Real * getValues

(

)

Definition at line 144 of file scipParaSolution.h.

References ScipParaSolution::values.

Referenced by ScipParaInstance::getSolValuesForOriginalProblem(), ScipParaSolver::tryNewSolution(), and ScipParaInitiator::tryToSetIncumbentSolution().

indexAmongSolvers()

int indexAmongSolvers

(

int

index

)

Definition at line 142 of file scipParaSolution.h.

References ScipParaSolution::indicesAmongSolvers.

Referenced by ScipParaInstance::getSolValuesForOriginalProblem(), ScipParaSolver::tryNewSolution(), and ScipParaInitiator::tryToSetIncumbentSolution().

read()

bool read ( UG::ParaComm *  comm, gzstream::igzstream &  in  )

virtual

user should implement read method

Implements ParaSolution.

Definition at line 58 of file scipParaSolution.cpp.

References ScipParaSolution::indicesAmongSolvers, ScipParaSolution::nVars, ScipParaSolution::objectiveFunctionValue, and ScipParaSolution::values.

Referenced by ScipParaInitiator::readSolutionFromCheckpointFile().

setObjectiveFuntionValue()

void setObjectiveFuntionValue

(

SCIP_Real

val

)

set objective function value

Definition at line 137 of file scipParaSolution.h.

References ScipParaSolution::objectiveFunctionValue.

Referenced by ScipParaInitiator::tryToSetIncumbentSolution().

setValue()

void setValue	(	int	i,
		SCIP_Real	val
	)

Definition at line 145 of file scipParaSolution.h.

References ScipParaSolution::values.

Referenced by ScipParaInitiator::tryToSetIncumbentSolution().

toString()

const std::string toString ( )

virtual

stringfy solution

Reimplemented from ParaSolution.

Definition at line 156 of file scipParaSolution.h.

References ScipParaSolution::indicesAmongSolvers, ScipParaSolution::nVars, ScipParaSolution::objectiveFunctionValue, and ScipParaSolution::values.

write()

void write ( gzstream::ogzstream &  out )

virtual

user should implement write method

Implements ParaSolution.

Definition at line 44 of file scipParaSolution.cpp.

References ScipParaSolution::indicesAmongSolvers, ScipParaSolution::nVars, ScipParaSolution::objectiveFunctionValue, and ScipParaSolution::values.

Referenced by ScipParaInitiator::writeCheckpointSolution().

Member Data Documentation

indicesAmongSolvers

int* indicesAmongSolvers

protected

array of variable indices, mapping SCIPvarGetProbindex to SCIPvarGetIndex

Definition at line 54 of file scipParaSolution.h.

Referenced by ScipParaSolutionMpi::bcast(), ScipParaSolutionTh::bcast(), ScipParaSolutionMpi::clone(), ScipParaSolutionTh::clone(), ScipParaSolutionMpi::createDatatype(), ScipParaSolution::indexAmongSolvers(), ScipParaSolution::read(), ScipParaSolutionMpi::receive(), ScipParaSolutionTh::receive(), ScipParaSolution::ScipParaSolution(), ScipParaSolutionMpi::send(), ScipParaSolution::toString(), ScipParaSolution::write(), and ScipParaSolution::~ScipParaSolution().

nVars

int nVars

protected

number of variables

Definition at line 53 of file scipParaSolution.h.

Referenced by ScipParaSolutionMpi::bcast(), ScipParaSolutionTh::bcast(), ScipParaSolutionMpi::clone(), ScipParaSolutionTh::clone(), ScipParaSolutionMpi::createDatatype(), ScipParaSolutionMpi::createPreDatatype(), ScipParaSolution::getNVars(), ScipParaSolution::read(), ScipParaSolutionMpi::receive(), ScipParaSolutionTh::receive(), ScipParaSolution::ScipParaSolution(), ScipParaSolutionMpi::send(), ScipParaSolution::toString(), and ScipParaSolution::write().

objectiveFunctionValue

double objectiveFunctionValue

protected

Definition at line 52 of file scipParaSolution.h.

Referenced by ScipParaSolutionMpi::bcast(), ScipParaSolutionTh::bcast(), ScipParaSolutionMpi::clone(), ScipParaSolutionTh::clone(), ScipParaSolutionMpi::createPreDatatype(), ScipParaSolution::getObjectiveFunctionValue(), ScipParaSolution::read(), ScipParaSolutionMpi::receive(), ScipParaSolutionTh::receive(), ScipParaSolution::ScipParaSolution(), ScipParaSolutionMpi::send(), ScipParaSolution::setObjectiveFuntionValue(), ScipParaSolution::toString(), and ScipParaSolution::write().

values

SCIP_Real* values

protected

array of bounds which the branchings

Definition at line 55 of file scipParaSolution.h.

Referenced by ScipParaSolutionTh::bcast(), ScipParaSolutionMpi::clone(), ScipParaSolutionTh::clone(), ScipParaSolutionMpi::createDatatype(), ScipParaSolution::getValues(), ScipParaSolution::read(), ScipParaSolutionTh::receive(), ScipParaSolution::ScipParaSolution(), ScipParaSolution::setValue(), ScipParaSolution::toString(), ScipParaSolution::write(), and ScipParaSolution::~ScipParaSolution().