main page namespaces classes files
ELL home

ell::S_SG_Ising Class Reference

#include <S_SG_Ising.hh>

Inheritance diagram for ell::S_SG_Ising:

[legend]

---

Detailed Description

Representing a connected ring or spins.

Spins are neighbored iif : i+1 == j or (i==0 and j==(spinnumber-1))

Definition at line 17 of file S_SG_Ising.hh.

Public Types
typedef biu::VirtualList< State >	NeighborList
typedef std::auto_ptr< NeighborList >	NeighborListPtr
typedef biu::Alphabet::Sequence	SpinArray
typedef biu::Alphabet::AlphElem	SpinType
Public Member Functions
virtual State *	applyNeighborChange (const size_t index, State *const neigh) const
virtual State *	clone () const
virtual CSequence &	compress (CSequence &toFill) const
virtual CSequence	compress (void) const
virtual State *	fromString (const std::string &stringRep) const
virtual double	getEnergy () const
virtual int	getFitness () const
virtual unsigned int	getMinimalDistance (const State &state2) const
virtual State *	getNeighbor (const size_t index, State *neigh) const
virtual NeighborListPtr	getNeighborList () const
virtual size_t	getNeighborNumber (void) const
virtual State *	getRandomNeighbor (State *inPlaceNeigh=NULL) const
virtual NeighborListPtr	getRandomNeighborList () const
virtual bool	operator!= (const State &state2) const
virtual void	operator= (const S_SG_Ising &sg2)
virtual bool	operator== (const State &state2) const
	S_SG_Ising (const S_SG_Ising &s2)
	S_SG_Ising (const std::string &spinStr)
	S_SG_Ising (size_t size, bool random=true)
virtual std::string	toString () const
virtual State *	uncompress (const CSequence &cseq)
virtual State *	uncompress (const CSequence &cseq, State *toFill) const
virtual State *	undoNeighborChange (const size_t index, State *const neigh) const
virtual	~S_SG_Ising ()
Static Public Attributes
static const SpinType	SPIN_DOWN
static const SpinType	SPIN_UP
Protected Member Functions
SpinType	flipSpin (SpinType s) const
Protected Attributes
SpinArray	spin
Static Protected Attributes
static const biu::Alphabet	spinAlph

---

Member Typedef Documentation

typedef biu::VirtualList<State> ell::State::NeighborList [inherited]

Virtual list of neighbor states which can be accessed by a STL-like iterator.

Definition at line 43 of file State.hh.

typedef std::auto_ptr<NeighborList> ell::State::NeighborListPtr [inherited]

An autopointer to a NeighborList.

Definition at line 46 of file State.hh.

typedef biu::Alphabet::Sequence ell::S_SG_Ising::SpinArray

type of the spin array representation

Definition at line 24 of file S_SG_Ising.hh.

typedef biu::Alphabet::AlphElem ell::S_SG_Ising::SpinType

spin representation

Definition at line 22 of file S_SG_Ising.hh.

---

Constructor & Destructor Documentation

ell::S_SG_Ising::S_SG_Ising	(	size_t	size,
		bool	random = true
	)

Constructs a spin array of the given size and initializes with SPIN_UP for all spins or a random distribution.

Parameters:

	size	the size of the spin array
	random	if true a random initialization is done

Definition at line 18 of file S_SG_Ising.cc.

ell::S_SG_Ising::S_SG_Ising

(

const std::string &

spinStr

)

Constructs a spin array from the given spin string

Parameters:

spinStr

the +- spin string

Definition at line 28 of file S_SG_Ising.cc.

ell::S_SG_Ising::S_SG_Ising

(

const S_SG_Ising &

s2

)

Definition at line 35 of file S_SG_Ising.cc.

ell::S_SG_Ising::~S_SG_Ising

(

)

[virtual]

Definition at line 40 of file S_SG_Ising.cc.

---

Member Function Documentation

State * ell::S_SG_Ising::applyNeighborChange	(	const size_t	index,
		State *const	neigh
	)			const [virtual]

Applies the necessary changes to a given state to get the neighbor. Note: neigh is expected to be a copy (i.e. *this == *neigh) and therefore direct changes are possible or to be NULL. If (neigh==NULL) a copy of this has to be generated, modified, and returned.

Parameters:

	index	the neighbor to generate
	neigh	a copy of this the changes should be applied to

Returns:

the neighbor state of the given index or NULL if the index is out of range

Implements ell::IterableNeighbors.

Reimplemented in ell::S_SG_NPP.

Definition at line 220 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::clone

(

)

const [virtual]

Returns a pointer to a clone of the current state.

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 106 of file S_SG_Ising.cc.

CSequence & ell::S_SG_Ising::compress

(

CSequence &

toFill

)

const [virtual]

Access to a compressed sequence representation of the state.

Parameters:

toFill

a data structure to write the compressed representation too

Returns:

the compressed sequence representation

Implements ell::State.

Definition at line 246 of file S_SG_Ising.cc.

CSequence ell::S_SG_Ising::compress

(

void

)

const [virtual]

Access to a compressed sequence representation of the state.

Returns:

the compressed sequence representation

Implements ell::State.

Definition at line 236 of file S_SG_Ising.cc.

SpinType ell::S_SG_Ising::flipSpin

(

SpinType

s

)

const [inline, protected]

flips the given spin (used for neighbor generation)

Definition at line 178 of file S_SG_Ising.hh.

State * ell::S_SG_Ising::fromString

(

const std::string &

stringRep

)

const [virtual]

Returns a new State based on the current state. The new state differs only by the information given by stringRep.

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 113 of file S_SG_Ising.cc.

double ell::S_SG_Ising::getEnergy

(

)

const [virtual]

Returns the state specific energy, i.e. E = sum ( J(i,j)*spin(i)*spin(j) ) for all 0<=i<j<=spinnumber and J(i,j) = 1 iif spin i and j are neighbored and 0 otherwise.

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 74 of file S_SG_Ising.cc.

int ell::S_SG_Ising::getFitness

(

)

const [virtual]

Returns the negated energy of the spinglass.

Implements ell::State.

Definition at line 66 of file S_SG_Ising.cc.

unsigned int ell::S_SG_Ising::getMinimalDistance

(

const State &

state2

)

const [virtual]

Returns the minimal number of steps via valid neighbored states from this to another valid State.

Parameters:

state2

the State to reach

Returns:

if state2 is a S_SG_Ising state the minimal distance or UINT_MAX otherwise

Implements ell::State.

Definition at line 91 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::getNeighbor	(	const size_t	index,
		State *	neigh
	)			const [virtual]

Access to a specific neighbor.

Parameters:

	index	the index of the neighbor in [0, getNeighborNumber())
	neigh	if != NULL this state should be converted into the neighbor otherwise a new one is created and returned

Returns:

the new neighbor state or NULL if the index is >= getNeighborNumber()

Implements ell::IterableNeighbors.

Reimplemented in ell::S_SG_NPP.

Definition at line 181 of file S_SG_Ising.cc.

State::NeighborListPtr ell::S_SG_Ising::getNeighborList

(

)

const [virtual]

Returns a virtual list of all VALID neighbored states in the energy landscape in a specific successive order.

Implements ell::State.

Definition at line 130 of file S_SG_Ising.cc.

size_t ell::S_SG_Ising::getNeighborNumber

(

void

)

const [virtual]

How many neighbor indices are accessible.

Returns:

the number of neighbors

Implements ell::IterableNeighbors.

Definition at line 170 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::getRandomNeighbor

(

State *

inPlaceNeigh = NULL

)

const [virtual]

Returns a VALID random neighbored state. If a state is given it is overwritten and changed to a neighbor.

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 147 of file S_SG_Ising.cc.

State::NeighborListPtr ell::S_SG_Ising::getRandomNeighborList

(

)

const [virtual]

Returns a virtual list of all VALID neighbored states in the energy landscape in a random order.

Implements ell::State.

Definition at line 139 of file S_SG_Ising.cc.

bool ell::S_SG_Ising::operator!=

(

const State &

state2

)

const [virtual]

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 50 of file S_SG_Ising.cc.

void ell::S_SG_Ising::operator=

(

const S_SG_Ising &

sg2

)

[virtual]

Definition at line 55 of file S_SG_Ising.cc.

bool ell::S_SG_Ising::operator==

(

const State &

state2

)

const [virtual]

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 45 of file S_SG_Ising.cc.

std::string ell::S_SG_Ising::toString

(

)

const [virtual]

Returns a +- std::string representation of this spin glass array.

Implements ell::State.

Definition at line 121 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::uncompress

(

const CSequence &

cseq

)

[virtual]

Uncompresses a compressed sequencce representation into a this State object.

Parameters:

cseq

the compressed sequence representation of a state

Returns:

this or NULL in error case

Implements ell::State.

Definition at line 278 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::uncompress	(	const CSequence &	cseq,
		State *	toFill
	)			const [virtual]

Uncompresses a compressed sequencce representation into a new State object.

Parameters:

	cseq	the compressed sequence representation of a state
	toFill	a state object to uncompress too or NULL if a new object has to be created

Returns:

new State object that is encoded in cseq or NULL in error case.

Implements ell::State.

Reimplemented in ell::S_SG_NPP.

Definition at line 260 of file S_SG_Ising.cc.

State * ell::S_SG_Ising::undoNeighborChange	(	const size_t	index,
		State *const	neigh
	)			const [virtual]

Undo the changes done to this state to generate the given neighbor. The goal is to do less operations than doing a full copy like (*neigh = *this).

Parameters:

	index	the neighbor index that was applied last [ 0, getNeighborNumber() )
	neigh	the state resulting from the last changes ( != NULL)

Returns:

the copy of this object via undoing the last changes in neigh

Implements ell::IterableNeighbors.

Definition at line 202 of file S_SG_Ising.cc.

---

Field Documentation

SpinArray ell::S_SG_Ising::spin [protected]

the spin array representing the +-1 spin

Definition at line 35 of file S_SG_Ising.hh.

const S_SG_Ising::SpinType ell::S_SG_Ising::SPIN_DOWN [static]

Definition at line 27 of file S_SG_Ising.hh.

const S_SG_Ising::SpinType ell::S_SG_Ising::SPIN_UP [static]

Definition at line 26 of file S_SG_Ising.hh.

const biu::Alphabet ell::S_SG_Ising::spinAlph [static, protected]

the spin alphabet class for compression usage

Definition at line 32 of file S_SG_Ising.hh.

---

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

• src/ell/spinglass/S_SG_Ising.hh
• src/ell/spinglass/S_SG_Ising.cc