WarmStart information that is only a vector. More...

#include <CoinWarmStartVector.hpp>

Inheritance diagram for CoinWarmStartVector< T >:

Collaboration diagram for CoinWarmStartVector< T >:

Public Member Functions
int	size () const
	return the size of the vector
const T *	values () const
	return a pointer to the array of vectors
void	assignVector (int size, T *&vec)
	Assign the vector to be the warmstart information.
	CoinWarmStartVector ()
	CoinWarmStartVector (int size, const T *vec)
	CoinWarmStartVector (const CoinWarmStartVector &rhs)
CoinWarmStartVector &	operator= (const CoinWarmStartVector &rhs)
void	swap (CoinWarmStartVector &rhs)
void	clear ()
	`Virtual constructor' / virtual CoinWarmStart clone() const { return new CoinWarmStartVector(*this); }
Vector warm start `diff' methods */
/! Generate a `diff' that can convert the warm start passed as a parameter to the warm start specified by `this`. The capabilities are limited: the basis passed as a parameter can be no larger than the basis pointed to by `this`. / virtual CoinWarmStartDiff * generateDiff(const CoinWarmStart const oldCWS) const; /! Apply `diff` to this warm start. Update this warm start by applying `diff`. It's assumed that the allocated capacity of the warm start is sufficiently large.
virtual void	applyDiff (const CoinWarmStartDiff *const cwsdDiff)
Public Member Functions inherited from CoinWarmStart
virtual	~CoinWarmStart ()
	Abstract destructor.
virtual CoinWarmStart *	clone () const =0
	`Virtual constructor'
virtual CoinWarmStartDiff *	generateDiff (const CoinWarmStart *const) const

Protected Member Functions
void	gutsOfDestructor ()
void	gutsOfCopy (const CoinWarmStartVector< T > &rhs)

Private Attributes
Private data members
int	size_
	the size of the vector
T *	values_
	the vector itself

Detailed Description

template<typename T>
class CoinWarmStartVector< T >

WarmStart information that is only a vector.

Definition at line 25 of file CoinWarmStartVector.hpp.

Constructor & Destructor Documentation

◆ CoinWarmStartVector() [1/3]

template<typename T>

CoinWarmStartVector< T >::CoinWarmStartVector ( )

inline

Definition at line 55 of file CoinWarmStartVector.hpp.

◆ CoinWarmStartVector() [2/3]

template<typename T>

CoinWarmStartVector< T >::CoinWarmStartVector	(	int	size,
		const T *	vec )

inline

Definition at line 61 of file CoinWarmStartVector.hpp.

◆ CoinWarmStartVector() [3/3]

template<typename T>

CoinWarmStartVector< T >::CoinWarmStartVector ( const CoinWarmStartVector< T > & rhs )

inline

Definition at line 68 of file CoinWarmStartVector.hpp.

Member Function Documentation

◆ gutsOfDestructor()

template<typename T>

void CoinWarmStartVector< T >::gutsOfDestructor ( )

inlineprotected

Definition at line 27 of file CoinWarmStartVector.hpp.

◆ gutsOfCopy()

template<typename T>

void CoinWarmStartVector< T >::gutsOfCopy ( const CoinWarmStartVector< T > & rhs )

inlineprotected

Definition at line 31 of file CoinWarmStartVector.hpp.

◆ size()

template<typename T>

int CoinWarmStartVector< T >::size ( ) const

inline

return the size of the vector

Definition at line 40 of file CoinWarmStartVector.hpp.

◆ values()

template<typename T>

const T * CoinWarmStartVector< T >::values ( ) const

inline

return a pointer to the array of vectors

Definition at line 42 of file CoinWarmStartVector.hpp.

◆ assignVector()

template<typename T>

void CoinWarmStartVector< T >::assignVector	(	int	size,
		T *&	vec )

inline

Assign the vector to be the warmstart information.

In this method the object assumes ownership of the pointer and upon return #vector will be a NULL pointer. If copying is desirable use the constructor.

Definition at line 47 of file CoinWarmStartVector.hpp.

◆ operator=()

template<typename T>

CoinWarmStartVector & CoinWarmStartVector< T >::operator= ( const CoinWarmStartVector< T > & rhs )

inline

Definition at line 73 of file CoinWarmStartVector.hpp.

◆ swap()

template<typename T>

void CoinWarmStartVector< T >::swap ( CoinWarmStartVector< T > & rhs )

inline

Definition at line 82 of file CoinWarmStartVector.hpp.

◆ clear()

template<typename T>

void CoinWarmStartVector< T >::clear ( )

inline

`Virtual constructor' */ virtual CoinWarmStart *clone() const { return new CoinWarmStartVector(*this); }

virtual ~CoinWarmStartVector() { gutsOfDestructor(); }

/*! Clear the data

Make it appear as if the warmstart was just created using the default constructor.

Definition at line 106 of file CoinWarmStartVector.hpp.

◆ applyDiff()

template<typename T>

void CoinWarmStartVector< T >::applyDiff ( const CoinWarmStartDiff *const cwsdDiff )

virtual

Reimplemented from CoinWarmStart.

Definition at line 435 of file CoinWarmStartVector.hpp.

Member Data Documentation

◆ size_

template<typename T>

int CoinWarmStartVector< T >::size_

private

the size of the vector

Definition at line 140 of file CoinWarmStartVector.hpp.

◆ values_

template<typename T>

T* CoinWarmStartVector< T >::values_

private

the vector itself

Definition at line 142 of file CoinWarmStartVector.hpp.

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

/builddir/build/BUILD/coin-or-CoinUtils-2.11.12-build/CoinUtils-releases-2.11.12/CoinUtils/src/CoinWarmStartVector.hpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CoinWarmStartVector() [1/3]

◆ CoinWarmStartVector() [2/3]

◆ CoinWarmStartVector() [3/3]

Member Function Documentation

◆ gutsOfDestructor()

◆ gutsOfCopy()

◆ size()

◆ values()

◆ assignVector()

◆ operator=()

◆ swap()

◆ clear()

◆ applyDiff()

Member Data Documentation

◆ size_

◆ values_