1

/* $Id$ */

     2

     3

/** @file smallvec_type.hpp Simple vector class that allows allocating an item without the need to copy this->data needlessly. */

     4

     5

#ifndef SMALLVEC_TYPE_HPP

     6

#define SMALLVEC_TYPE_HPP

     7

     8

#include "alloc_func.hpp"

     9

#include "math_func.hpp"

    10

    11

/**

    12

 * Simple vector template class.

    13

 *

    14

 * @note There are no asserts in the class so you have

    15

 *       to care about that you grab an item which is

    16

 *       inside the list.

    17

 *

    18

 * @param T The type of the items stored

    19

 * @param S The steps of allocation

    20

 */

    21

template <typename T, uint S>

    22

class SmallVector {

    23

protected:

    24

	T *data;       ///< The pointer to the first item

    25

	uint items;    ///< The number of items stored

    26

	uint capacity; ///< The avalible space for storing items

    27

    28

public:

    29

	SmallVector() : data(NULL), items(0), capacity(0) { }

    30

    31

	~SmallVector()

    32

	{

    33

		free(this->data);

    34

	}

    35

    36

	/**

    37

	 * Remove all items from the list.

    38

	 */

    40

	{

    41

		/* In fact we just reset the item counter avoiding the need to

    42

		 * probably reallocate the same amount of memory the list was

    43

		 * previously using. */

    44

		this->items = 0;

    45

	}

    46

    47

	/**

    48

	 * Compact the list down to the smallest block size boundary.

    49

	 */

    51

	{

    52

		uint capacity = Align(this->items, S);

    53

		if (capacity >= this->capacity) return;

    54

    55

		this->capacity = capacity;

    56

		this->data = ReallocT(this->data, this->capacity);

    57

	}

    58

    59

	/**

    60

	 * Append an item and return it.

    61

	 */

    63

	{

    64

		if (this->items == this->capacity) {

    65

			this->capacity += S;

    66

			this->data = ReallocT(this->data, this->capacity);

    67

		}

    68

    69

		return &this->data[this->items++];

    70

	}

    71

    72

	/**

    73

	 * Get the number of items in the list.

    74

	 */

    76

	{

    77

		return this->items;

    78

	}

    79

    80

	/**

    81

	 * Get the pointer to the first item (const)

    82

	 *

    83

	 * @return the pointer to the first item

    84

	 */

    86

	{

    87

		return this->data;

    88

	}

    89

    90

	/**

    91

	 * Get the pointer to the first item

    92

	 *

    93

	 * @return the pointer to the first item

    94

	 */

    96

	{

    97

		return this->data;

    98

	}

    99

   100

	/**

   101

	 * Get the pointer behind the last valid item (const)

   102

	 *

   103

	 * @return the pointer behind the last valid item

   104

	 */

   106

	{

   107

		return &this->data[this->items];

   108

	}

   109

   110

	/**

   111

	 * Get the pointer behind the last valid item

   112

	 *

   113

	 * @return the pointer behind the last valid item

   114

	 */

   116

	{

   117

		return &this->data[this->items];

   118

	}

   119

   120

	/**

   121

	 * Get the pointer to item "number" (const)

   122

	 *

   123

	 * @param index the position of the item

   124

	 * @return the pointer to the item

   125

	 */

   127

	{

   128

		return &this->data[index];

   129

	}

   130

   131

	/**

   132

	 * Get the pointer to item "number"

   133

	 *

   134

	 * @param index the position of the item

   135

	 * @return the pointer to the item

   136

	 */

   138

	{

   139

		return &this->data[index];

   140

	}

   141

   142

	/**

   143

	 * Get item "number" (const)

   144

	 *

   145

	 * @param index the positon of the item

   146

	 * @return the item

   147

	 */

   149

	{

   150

		return this->data[index];

   151

	}

   152

   153

	/**

   154

	 * Get item "number"

   155

	 *

   156

	 * @param index the positon of the item

   157

	 * @return the item

   158

	 */

   160

	{

   161

		return this->data[index];

   162

	}

   163

};

   164

   165

#endif /* SMALLVEC_TYPE_HPP */