Dokumentacja klasy Vector

Klasa wektor Klasa odpowiedzialna za przechowywanie informacji o wektorze, jego rozmiarze i zawartosci. Więcej...

#include <Vector.h>

Lista wszystkich składowych.

Metody publiczne
unsigned int	getSize () const
std::string	toString () const
	Vector (unsigned int rozmiar=0)
	Vector (const std::string &raw)
	Vector (const Vector &Wzorzec)
Vector	operator+ (const Vector &rhs) const
Vector &	operator+= (const Vector &rhs)
Vector	operator- (const Vector &rhs) const
Vector &	operator-= (const Vector &rhs)
Vector	operator* (const int &rhs) const
Vector &	operator*= (const int &rhs)
int	operator* (const Vector &rhs) const
Vector &	operator= (const Vector &rhs)
Vector &	operator= (const std::string &rhs)
int	operator[] (const unsigned int index) const
int &	operator[] (const unsigned int index)
bool	operator== (const Vector &rhs) const
bool	operator!= (const Vector &rhs) const
	~Vector ()
Metody prywatne
void	chSize (unsigned int newSize)
	funkcja zmieniajaca rozmiar wektora/inicjalizujaca go
void	fromText (const std::string &raw)
Atrybuty prywatne
int *	content
	tablica skladowych wektora
unsigned int	size
	informacja o rozmiarze wektora
Przyjaciele
std::ostream &	operator<< (std::ostream &wyjscie, const Vector &wektorek)
std::istream &	operator>> (std::istream &wejscie, Vector &wektorek)
Vector	operator* (const int &lhs, const Vector &rhs)

---

Opis szczegółowy

Klasa wektor Klasa odpowiedzialna za przechowywanie informacji o wektorze, jego rozmiarze i zawartosci.

Dostarcza uzywaną powszechnie klase string z STL

Definicja w linii 35 pliku Vector.h.

---

Dokumentacja konstruktora i destruktora

Vector::Vector

(

unsigned int

rozmiar = 0

)

Konstruktor klasy wektor

Parametry:

rozmiar

Rozmiar konstruowanego wektora, domsylnie przyjmuje wartosc 0, co oznacza wektor niezainicjalizowany

Definicja w linii 13 pliku Vector.cpp.

Odwołuje się do content i size.

Vector::Vector

(

const std::string &

raw

)

Konstruktor klasy wektor

Zobacz również:

fromText()

Parametry:

raw

Referencja do stringa przechowujacego wektor

Zwraca:

Wektor utworzony na podstawie stringa

Definicja w linii 42 pliku Vector.cpp.

Odwołuje się do content, fromText() i size.

Vector::Vector

(

const Vector &

Wzorzec

)

Konstruktor kopiujący Konstruktor w rzie potrzeby przeprowadzający glębokie kopiowanie

Definicja w linii 48 pliku Vector.cpp.

Odwołuje się do content, DEBUG, size i toString().

Vector::~Vector

(

)

Destruktor

Definicja w linii 36 pliku Vector.cpp.

Odwołuje się do content, DEBUG i toString().

---

Dokumentacja funkcji składowych

void Vector::chSize

(

unsigned int

newSize

)

[private]

funkcja zmieniajaca rozmiar wektora/inicjalizujaca go

Definicja w linii 104 pliku Vector.cpp.

Odwołuje się do content i size.

Odwołania w fromText() i operator=().

void Vector::fromText

(

const std::string &

raw

)

[private]

Funkcja zamieniajaca odpowiednio sformatowany string na wektor

Parametry:

raw

Referencja do Stringu przechowującego sformatowany wektor

Definicja w linii 66 pliku Vector.cpp.

Odwołuje się do chSize(), content, DEBUG i policz().

Odwołania w operator=(), operator>>() i Vector().

unsigned int Vector::getSize

(

)

const [inline]

Akcesor zwracajacy rozmiar biezacego wektora

Definicja w linii 81 pliku Vector.h.

Odwołuje się do size.

std::string Vector::toString

(

)

const

Funckcja konwertująca wektor na odpowiednio sformatowany string

Zwraca:

Przygotowany String

Definicja w linii 18 pliku Vector.cpp.

Odwołuje się do content, IntToStr() i size.

Odwołania w operator+(), operator<<(), pokazVector(), Vector() i ~Vector().

Vector Vector::operator+

(

const Vector &

rhs

)

const

Operator dodawania Dodaje dwa wektory do siebie

Parametry:

rhs

Stała referencja do wektora po prawej stronie

Warunek wstępny:

Rozmiary musza sie zgadzac!

Zwraca:

Wynik dodawania lub wektor niezainicjalizowany w razie błędu

Definicja w linii 124 pliku Vector.cpp.

Odwołuje się do content, DEBUG, size i toString().

Vector & Vector::operator+=

(

const Vector &

rhs

)

Operator dodawania z przypisaniem Dodaje dwa wektory i wynik zapisuje w wektorze po lewej stroni

Parametry:

rhs

wektor po prawej stronie

Warunek wstępny:

Rozmiary musza sie zgadzac!

Zwraca:

Referencja do wektora po lewej stronie

Definicja w linii 145 pliku Vector.cpp.

Vector Vector::operator-

(

const Vector &

rhs

)

const

Operator odejmowania Odejmuje od wektora po lewej stornie wektor po prawej

Parametry:

rhs

Stała referencja do wektora po prawej stronie

Warunek wstępny:

Rozmiary musza sie zgadzac!

Zwraca:

Wynik odejmowania lub wektor niezainicjalizowany w razie błędu

Definicja w linii 160 pliku Vector.cpp.

Odwołuje się do content, DEBUG i size.

Vector & Vector::operator-=

(

const Vector &

rhs

)

Operator odejmowania z przypisaniem Odejmuje od wektora po lewej stornie wektor po prawej i wynik zapisuje w wektorze po lewej stroni

Parametry:

rhs

wektor po prawej stronie

Warunek wstępny:

Rozmiary musza sie zgadzac!

Zwraca:

Referencja do wektora po lewej stronie

Definicja w linii 150 pliku Vector.cpp.

Vector Vector::operator*

(

const int &

rhs

)

const

Definicja w linii 196 pliku Vector.cpp.

Odwołuje się do content i size.

Vector & Vector::operator*=

(

const int &

rhs

)

Definicja w linii 155 pliku Vector.cpp.

int Vector::operator*

(

const Vector &

rhs

)

const

Operator mnożenia Mnoży skalarnie dwa wektory

Parametry:

rhs

stała referencja do drugiego wektora

Warunek wstępny:

Rozmiary musza sie zgadzac!

Zwraca:

Iloczyn skalarny dwoch wektorow

Definicja w linii 180 pliku Vector.cpp.

Odwołuje się do content i size.

Vector & Vector::operator=

(

const Vector &

rhs

)

Operator przypisania

Parametry:

rhs

referencja do przypisywanego wektora Przypisuje do lewej strony wektor z prawej, w razie potrzeby zmienai rozmiar

Zwraca:

Referencja do przypisanego wektora

Definicja w linii 111 pliku Vector.cpp.

Odwołuje się do chSize(), content i size.

Vector & Vector::operator=

(

const std::string &

rhs

)

Operator przypisania Przypisuje do lewej strony wektor z prawej, w razie potrzeby zmienai rozmiar

Parametry:

rhs

referencja do tekstu zawierajacego wektor.

Zwraca:

Referencja do przypisanego wektora

Definicja w linii 119 pliku Vector.cpp.

Odwołuje się do fromText().

int Vector::operator[]

(

const unsigned int

index

)

const

Operator indeksu do odczytu Potrzebny aby moc cos odczytac gdyby wektor był uzywany jako element stały

Zwraca:

Wartosc elementu na pozycji index

Parametry:

index

offset elementu ktory chcemy odczytac

int & Vector::operator[]

(

const unsigned int

index

)

Operator indeksu do zapisu Do edycji wybranej skladowej

Zwraca:

Referencje do zmiennej liczbowej reprezentujaca dana skladowa

Parametry:

index

offset elementu ktory chcemy zapisac

Definicja w linii 239 pliku Vector.cpp.

Odwołuje się do content i size.

bool Vector::operator==

(

const Vector &

rhs

)

const

Operator porownywania 2 wekorów (rownosc)

Zwraca:

True lub False

Parametry:

rhs

Stała referencja do porywnywanego wektora

Definicja w linii 214 pliku Vector.cpp.

Odwołuje się do content i size.

bool Vector::operator!=

(

const Vector &

rhs

)

const [inline]

Operator porownania 2 wektorow (nierownosc)

Zwraca:

True lub False

Parametry:

rhs

Stała referencja do porywnywanego wektora

Definicja w linii 231 pliku Vector.h.

---

Dokumentacja przyjaciół i funkcji związanych

std::ostream& operator<<	(	std::ostream &	wyjscie,
		const Vector &	wektorek
	)			[friend]

Przeladowany operator wyjscia

Parametry:

	wyjscie	strumien wyjsciowy (ostream)
	wektorek	wektor do wypisania

Zwraca:

Referencja do strumienia

Definicja w linii 261 pliku Vector.cpp.

std::istream& operator>>	(	std::istream &	wejscie,
		Vector &	wektorek
	)			[friend]

Przeladowany operator wejscia

Parametry:

	wejscie	strumien wejsciowy (istream)
	wektorek	referencja do docelowego wektora

Zwraca:

Referencja do strumienia wejsciowego

Definicja w linii 266 pliku Vector.cpp.

Vector operator*	(	const int &	lhs,
		const Vector &	rhs
	)			[friend]

Definicja w linii 205 pliku Vector.cpp.

---

Dokumentacja atrybutów składowych

int* Vector::content [private]

tablica skladowych wektora

Definicja w linii 66 pliku Vector.h.

Odwołania w chSize(), fromText(), operator*(), operator*(), operator+(), operator-(), operator=(), operator==(), operator[](), toString(), Vector() i ~Vector().

unsigned int Vector::size [private]

informacja o rozmiarze wektora

Definicja w linii 67 pliku Vector.h.

Odwołania w chSize(), getSize(), operator*(), operator*(), operator+(), operator-(), operator=(), operator==(), operator[](), toString() i Vector().

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• Vector.h
• Vector.cpp