array.hpp File Reference

#include "basic.hpp"
#include "array.ipp"

Include dependency graph for array.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	array_rep< T >
	A concrete struct representing the implementation of an array. More...
class	array< T >
	A template class representing an array. More...

Macros
#define	TMPL   template <class T>

Functions
template<class T >
int	N (array< T > a)
	Get the length of the array.
template<class T >
T *	A (array< T > a)
	Get a pointer to the first element of the array.
template<class T >
array< T >	copy (array< T > x)
	Make a copy of an array.
	CONCRETE_TEMPLATE_CODE (array, class, T)
template<class T >
tm_ostream &	operator<< (tm_ostream &out, array< T > a)
	Output the array to an output stream.
template<class T >
array< T > &	operator<< (array< T > &a, T x)
	Append an element to the end of the array.
template<class T >
array< T > &	operator<< (array< T > &a, array< T > b)
	Append an array to the end of another array.
template<class T >
bool	contains (T a, array< T > b)
	Check if an array contains a specified element.
template<class T >
array< T >	append (T a, array< T > b)
	Append an element to the beginning of an array.
template<class T >
array< T >	append (array< T > a, array< T > b)
	Append an array to the end of another array.
template<class T >
array< T >	range (array< T > a, int i, int j)
	Get a subarray of an array.
template<class T >
array< T >	reverse (array< T > a)
	Reverse an array.
template<class T >
bool	operator== (array< T > a, array< T > b)
	Check if two arrays are equal.
template<class T >
bool	operator!= (array< T > a, array< T > b)
	Check if two arrays are not equal.
template<class T >
array< T >	operator* (array< T > a, T c)
	Multiply an array object by a scalar value of type T.
template<class T >
array< T >	operator/ (array< T > a, T c)
	Divide an array object by a scalar value of type T.
template<class T >
int	hash (array< T > a)
	This function computes the hash of an array object a.

Detailed Description

Copyright

GPLv3

defines a templated array class representing a fixed-size array of elements.

Author

Joris van der Hoeven

Date

1999

Definition in file array.hpp.

Macro Definition Documentation

TMPL

#define TMPL   template <class T>

Definition at line 168 of file array.hpp.

Function Documentation

N()

template<class T >

int N ( array< T > a )

inline

Get the length of the array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.

Returns

The length of the array.

Definition at line 170 of file array.hpp.

               {
  return a->n;
}

A()

template<class T >

T * A ( array< T > a )

inline

Get a pointer to the first element of the array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.

Returns

A pointer to the first element of the array.

Definition at line 174 of file array.hpp.

               {
  return a->a;
}

copy()

template<class T >

array< T > copy ( array< T > x )

inline

Make a copy of an array.

Template Parameters

T	Type of elements in the array.

Parameters

x	The array to be copied.

Returns

A copy of the array.

Definition at line 178 of file array.hpp.

                  {
  return array<T> (a->a, a->n);
}

CONCRETE_TEMPLATE_CODE()

CONCRETE_TEMPLATE_CODE	(	array	,
		class	,
		T	)

operator<<() [1/3]

template<class T >

tm_ostream & operator<<	(	tm_ostream &	out,
		array< T >	a )

Output the array to an output stream.

Template Parameters

T	Type of elements in the array.

Parameters

out	The output stream.
a	The array to be output.

Returns

The output stream.

Definition at line 119 of file array.ipp.

                                         {
  int i;
 
  if (N (a) == 0) return out << "[ ]";
  out << "[ ";
  for (i= 0; i < N (a) - 1; i++)
    out << a[i] << ", ";
  if (N (a) != 0) out << a[i];
  out << " ]";
  return out;
}

operator<<() [2/3]

template<class T >

array< T > & operator<<	(	array< T > &	a,
		T	x )

Append an element to the end of the array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.
x	The element to be appended.

Returns

The updated array.

Definition at line 119 of file array.ipp.

                              {
  a->resize (N (a) + 1);
  a[N (a) - 1]= x;
  return a;
}

operator<<() [3/3]

template<class T >

array< T > & operator<<	(	array< T > &	a,
		array< T >	b )

Append an array to the end of another array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The first array.
b	The second array.

Returns

The updated array.

Definition at line 119 of file array.ipp.

                                     {
  int i, k= N (a);
  a->resize (N (a) + N (b));
  for (i= 0; i < N (b); i++)
    a[i + k]= b[i];
  return a;
}

contains()

template<class T >

bool contains	(	T	a,
		array< T >	b )

Check if an array contains a specified element.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.
b	The element to be checked.

Returns

True if the array contains the element, false otherwise.

append() [1/2]

template<class T >

array< T > append	(	T	a,
		array< T >	b )

Append an element to the beginning of an array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.
b	The element to be appended.

Returns

The updated array.

append() [2/2]

template<class T >

array< T > append	(	array< T >	a,
		array< T >	b )

Append an array to the end of another array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The first array.
b	The second array.

Returns

The updated array.

Definition at line 172 of file array.ipp.

                                {
  int      i, k= N (a), l= N (b);
  array<T> c (k + l);
  for (i= 0; i < k; i++)
    c[i]= a[i];
  for (i= 0; i < l; i++)
    c[i + k]= b[i];
  return c;
}

range()

template<class T >

array< T > range	(	array< T >	a,
		int	i,
		int	j )

Get a subarray of an array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.
i	The start index of the subarray.
j	The end index of the subarray.

Returns

The subarray.

Definition at line 184 of file array.ipp.

                                 {
  int k;
  ASSERT (i >= 0 && j <= N (a), "out of range");
  array<T> r (j - i);
  for (k= i; k < j; k++)
    r[k - i]= a[k];
  return r;
}

reverse()

template<class T >

array< T > reverse

(

array< T >

a

)

Reverse an array.

Template Parameters

T	Type of elements in the array.

Parameters

a	The array.

Returns

The reversed array.

Definition at line 195 of file array.ipp.

                     {
  int      i, n= N (a);
  array<T> r (n);
  for (i= 0; i < n; i++)
    r[i]= a[n - 1 - i];
  return r;
}

operator==()

template<class T >

bool operator==	(	array< T >	a,
		array< T >	b )

Check if two arrays are equal.

Template Parameters

T	Type of elements in the arrays.

Parameters

a	The first array.
b	The second array.

Returns

True if the two arrays are equal, false otherwise.

Definition at line 100 of file array.ipp.

                                    {
  int i;
  if (N (a) != N (b)) return false;
  for (i= 0; i < N (a); i++)
    if (a[i] != b[i]) return false;
  return true;
}

operator!=()

template<class T >

bool operator!=	(	array< T >	a,
		array< T >	b )

Check if two arrays are not equal.

Template Parameters

T	Type of elements in the arrays.

Parameters

a	The first array.
b	The second array.

Returns

True if the two arrays are not equal, false otherwise.

Definition at line 110 of file array.ipp.

                                    {
  int i;
  if (N (a) != N (b)) return true;
  for (i= 0; i < N (a); i++)
    if (a[i] != b[i]) return true;
  return false;
}

operator*()

template<class T >

array< T > operator*	(	array< T >	a,
		T	c )

Multiply an array object by a scalar value of type T.

Parameters

a	The target array.
c	The scalar value.

Returns

Return a new array object whose elements are the elements of a multiplied by c.

Definition at line 214 of file array.ipp.

                            {
  int      i, n= N (a);
  array<T> r (n);
  for (i= 0; i < n; i++)
    r[i]= a[i] * c;
  return r;
}

operator/()

template<class T >

array< T > operator/	(	array< T >	a,
		T	c )

Divide an array object by a scalar value of type T.

Parameters

a	The target array.
c	The scalar value.

Returns

Return a new array object whose elements are the elements of a divided by c.

Definition at line 224 of file array.ipp.

                            {
  int      i, n= N (a);
  array<T> r (n);
  for (i= 0; i < n; i++)
    r[i]= a[i] / c;
  return r;
}

hash()

template<class T >

int hash

(

array< T >

a

)

This function computes the hash of an array object a.

Parameters

a	The array object.

Returns

Return an integer hash value.

Definition at line 205 of file array.ipp.

                  {
  int i, n= N (a), h= 0;
  for (i= 0; i < n; i++)
    h= hash (a[i]) ^ ((h << 7) + (h >> 25));
  return h;
}