avector.h

Go to the documentation of this file.

/* ------------------------------------------------------------
 This is the file "avector.h" of the H2Lib package.
 All rights reserved, Steffen Boerm 2009
 ------------------------------------------------------------ */

#ifndef AVECTOR_H
#define AVECTOR_H

typedef struct _avector avector;

typedef avector *pavector;

typedef const avector *pcavector;

#include <assert.h>
#include <math.h>
#include <stdlib.h>

#include "basic.h"
#include "blas.h"
#include "amatrix.h"
#include "settings.h"

struct _avector {
  field *v;

  uint dim;

  void *owner;
};

/* ------------------------------------------------------------
 Constructors and destructors
 ------------------------------------------------------------ */

HEADER_PREFIX pavector
init_avector(pavector v, uint dim);

HEADER_PREFIX pavector
init_sub_avector(pavector v, pavector src, uint dim, uint off);

HEADER_PREFIX pavector
init_zero_avector(pavector v, uint dim);

HEADER_PREFIX pavector
init_column_avector(pavector v, pamatrix src, uint col);

HEADER_PREFIX pavector
init_pointer_avector(pavector v, pfield src, uint dim);

HEADER_PREFIX void
uninit_avector(pavector v);

HEADER_PREFIX pavector
new_avector(uint dim);

HEADER_PREFIX pavector
new_sub_avector(pavector src, uint dim, uint off);

HEADER_PREFIX pavector
new_zero_avector(uint dim);

HEADER_PREFIX pavector
new_pointer_avector(pfield src, uint dim);

HEADER_PREFIX void
del_avector(pavector v);

HEADER_PREFIX void
resize_avector(pavector v, uint dim);

HEADER_PREFIX void
shrink_avector(pavector v, uint dim);

/* ------------------------------------------------------------
 Access methods
 ------------------------------------------------------------ */

#ifdef __GNUC__
INLINE_PREFIX field
getentry_avector(pcavector, uint) __attribute__((const,unused));
INLINE_PREFIX void
setentry_avector(pavector, uint, field) __attribute__((unused));
INLINE_PREFIX field
addentry_avector(pavector, uint, field) __attribute__((unused));
#endif

INLINE_PREFIX field getentry_avector(pcavector v, uint i) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif
  return v->v[i];
}

INLINE_PREFIX void setentry_avector(pavector v, uint i, field x) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif

  v->v[i] = x;
}

INLINE_PREFIX field addentry_avector(pavector v, uint i, field x) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif

  return (v->v[i] += x);
}

/* ------------------------------------------------------------
 Statistics
 ------------------------------------------------------------ */

HEADER_PREFIX uint
getactives_avector();

HEADER_PREFIX size_t
getsize_avector(pcavector v);

HEADER_PREFIX size_t
getsize_heap_avector(pcavector v);

/* ------------------------------------------------------------
 Simple utility functions
 ------------------------------------------------------------ */

HEADER_PREFIX void
clear_avector(pavector v);

HEADER_PREFIX void
fill_avector(pavector v, field x);

HEADER_PREFIX void
random_avector(pavector v);

HEADER_PREFIX void
random_real_avector(pavector v);

HEADER_PREFIX void
copy_avector(pcavector v, pavector w);

HEADER_PREFIX void
copy_sub_avector(pcavector v, pavector w);

HEADER_PREFIX void
print_avector(pcavector v);

/* ------------------------------------------------------------
 Very basic linear algebra
 ------------------------------------------------------------ */

HEADER_PREFIX void
scale_avector(field alpha, pavector v);

HEADER_PREFIX real
norm2_avector(pcavector v);

HEADER_PREFIX field
dotprod_avector(pcavector x, pcavector y);

HEADER_PREFIX void
add_avector(field alpha, pcavector x, pavector y);

#endif