sparseVector Class Reference

#include <sparse-vector.hpp>

Inheritance diagram for sparseVector:

[legend]Collaboration diagram for sparseVector:

[legend]List of all members.

---

Detailed Description

A sparse vector is essentially a linked list structure with an index value in each node that is used for positioning of a node.

See also:

sparseVectorNode

Definition at line 37 of file sparse-vector.hpp.

Public Member Functions
	sparseVector ()
	sparseVector (sparseVectorNode *p)
void	setRoot (sparseVectorNode *p)
sparseVectorNode *	getRoot ()
void	addAt (int, sparseVectorNode *)
sparseVectorNode *	findAt (int)
char *	dumpAsXML ()

---

Constructor & Destructor Documentation

sparseVector::sparseVector

(

)

[inline]

A normal class constructor where no nodes are passed in for initialization. The root node is constructed within this constructor.

Definition at line 47 of file sparse-vector.hpp.

                      {
                root = new sparseVectorNode(-1,(sparseVectorNode*)0);
                
        };

sparseVector::sparseVector

(

sparseVectorNode *

p

)

[inline]

A rarely used form of the class constructor where we deliberately set the root node with a supplied value.

Parameters:

p

a pointer to a sparseVectorNode object.

Definition at line 59 of file sparse-vector.hpp.

                                         {
                root=p;
        };

---

Member Function Documentation

void sparseVector::addAt	(	int	,
		sparseVectorNode *
	)

Add a sparseVector to the sparse vector. If there already exists a node at the index specified then the node passed will replace the node already in the structure.

Parameters:

	int	integer value representing the index to set the node to.
	sparseVectorNode*	pointer to the sparseVectorNode to be added.

Definition at line 32 of file sparse-vector.cpp.

References sparseVectorNode::getIndex(), sparseVectorNode::getNext(), and sparseVectorNode::setNext().

Referenced by orbitPlane::add(), and star::placeCompanion().

                                                  {
        sparseVectorNode* p=root;
        
        n -> setIndex(ix); // Just to make sure for sanity's sake later. 
        

        if ( p->getNext() == (sparseVectorNode*) 0 ) { // Root node points to zero
                p->setNext(n);
                n->setNext((sparseVectorNode* ) 0 );
        } else { 
                while ( p->getNext() != (sparseVectorNode*)0){
                        p = p->getNext();
                        if ( (p->getNext() != (sparseVectorNode*)0) &&
                                 (p->getNext()->getIndex() > n->getIndex()) ){
                                n->setNext(p->getNext());
                                p->setNext(n);
                                return;
                        }
                }
                
                p->setNext(n);
                n->setNext((sparseVectorNode*)0);
                return;
        }
        
}

Here is the call graph for this function:

Here is the caller graph for this function:

char * sparseVector::dumpAsXML

(

)

Dump an XML represention of the structure. This should get overloaded by child classes of this class.

Definition at line 96 of file sparse-vector.cpp.

References sparseVectorNode::getNext().

                              {
        // Get ready folks.. this will be ugly...
        char * s;
        sparseVectorNode* p;
        
        s=(char*) malloc(129);
        s[0]='\0';
        
        sprintf(s,"%s\n",XMLSTART);
        if ( root->getNext() == (sparseVectorNode*)0){
                strcat(s,XMLEND);
                return s;
        } else {
                p=root->getNext();
                s = addXML(s,p);
                while(p->getNext() != (sparseVectorNode*)0){
                        p=p->getNext();
                        s=addXML(s,p);
                }
        }
        strcat(s,XMLEND);
        
        return s;
}

Here is the call graph for this function:

sparseVectorNode * sparseVector::findAt

(

int

)

Find the sparseVectorNode in the list occupying index value passed.

Parameters:

int

-- integer index for node being searched for.

Returns:

sparseVectorNode pointer of the node occupying index passed or null if it doesn't exist

Definition at line 65 of file sparse-vector.cpp.

References sparseVectorNode::getIndex(), and sparseVectorNode::getNext().

                                            {
        sparseVectorNode* p = root;
        
        if ( root->getNext() == (sparseVectorNode*) 0 ) 
                return (sparseVectorNode* ) 0;
        while(p->getNext() != (sparseVectorNode*)0){
                p = p->getNext();
                if ( p->getIndex() == ix ) 
                        return p;
        }
        return (p->getIndex() == ix ? p : (sparseVectorNode*) 0 );
        
}

Here is the call graph for this function:

sparseVectorNode* sparseVector::getRoot

(

)

[inline]

A getter function to return the current root node.

Returns:

pointer to a sparseVectorNode which is the current root node.

Definition at line 76 of file sparse-vector.hpp.

{ return root; };

void sparseVector::setRoot

(

sparseVectorNode *

p

)

[inline]

A setter funnction that ges the value of the root node.

Parameters:

p

a pointer to a sparseVectorNode that will be used as the root node

Definition at line 69 of file sparse-vector.hpp.

{ root=p;};

---

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

• include/sparse-vector.hpp
• src/sparse-vector.cpp

---