realavector.h

Go to the documentation of this file.

/* ------------------------------------------------------------
 This is the file "realavector.h" of the H2Lib package.
 All rights reserved, Sven Christophersen 2015
 ------------------------------------------------------------ */

#ifndef REALAVECTOR_H_
#define REALAVECTOR_H_

/* C STD LIBRARY */
#include <assert.h>
#include <math.h>
#include <stdlib.h>
/* CORE 0 */
#include "settings.h"
#include "basic.h"
#include "blas.h"
/* CORE 1 */
/* CORE 2 */
/* CORE 3 */
/* SIMPLE */
/* PARTICLES */
/* BEM */

typedef struct _realavector realavector;

typedef realavector *prealavector;

typedef const realavector *pcrealavector;

struct _realavector {
  real *v;

  uint dim;

  void *owner;
};

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

HEADER_PREFIX prealavector
init_realavector(prealavector v, uint dim);

HEADER_PREFIX prealavector
init_sub_realavector(prealavector v, prealavector src, uint dim, uint off);
HEADER_PREFIX prealavector
init_pointer_realavector(prealavector v, preal src, uint dim);

HEADER_PREFIX void
uninit_realavector(prealavector v);

HEADER_PREFIX prealavector
new_realavector(uint dim);

HEADER_PREFIX prealavector
new_sub_realavector(prealavector src, uint dim, uint off);

HEADER_PREFIX prealavector
new_pointer_realavector(preal src, uint dim);

HEADER_PREFIX void
del_realavector(prealavector v);

HEADER_PREFIX void
resize_realavector(prealavector v, uint dim);

HEADER_PREFIX void
shrink_realavector(prealavector v, uint dim);

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

#ifdef __GNUC__
INLINE_PREFIX real
getentry_realavector(pcrealavector, uint) __attribute__((const,unused));
INLINE_PREFIX void
setentry_realavector(prealavector, uint, real) __attribute__((unused));
INLINE_PREFIX real
addentry_realavector(prealavector, uint, real) __attribute__((unused));
#endif

INLINE_PREFIX real getentry_realavector(pcrealavector v, uint i) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif
  return v->v[i];
}

INLINE_PREFIX void setentry_realavector(prealavector v, uint i, real x) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif

  v->v[i] = x;
}

INLINE_PREFIX real addentry_realavector(prealavector v, uint i, real x) {
#ifdef FULL_DEBUG
  assert(i < v->dim);
#endif

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

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

HEADER_PREFIX uint
getactives_realavector();

HEADER_PREFIX size_t
getsize_realavector(pcrealavector v);

HEADER_PREFIX size_t
getsize_heap_realavector(pcrealavector v);

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

HEADER_PREFIX void
clear_realavector(prealavector v);

HEADER_PREFIX void
fill_realavector(prealavector v, real x);

HEADER_PREFIX void
random_realavector(prealavector v);

HEADER_PREFIX void
copy_realavector(pcrealavector v, prealavector w);

HEADER_PREFIX void
copy_sub_realavector(pcrealavector v, prealavector w);

HEADER_PREFIX void
print_realavector(pcrealavector v);

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

HEADER_PREFIX void
scale_realavector(real alpha, prealavector v);

HEADER_PREFIX real
norm2_realavector(pcrealavector v);

HEADER_PREFIX real
dotprod_realavector(pcrealavector x, pcrealavector y);

HEADER_PREFIX void
add_realavector(real alpha, pcrealavector x, prealavector y);

#endif /* REALAVECTOR_H_ */