MboVec.h

Go to the documentation of this file.

/*
Copyright 2014 Dominic Meiser

This file is part of mbo.

mbo is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your
option) any later version.

mbo is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with mbo.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MBO_VEC_H
#define MBO_VEC_H

#include <MboExport.h>
#include <MboErrors.h>
#include <MboIndices.h>

#ifdef __cplusplus
extern "C" {
#endif

struct MboAmplitude;
struct MboVec_t;
typedef struct MboVec_t *MboVec;


MBO_EXPORT MBO_STATUS mboVecCreate(MboGlobInd dim, MboVec *v);

MBO_EXPORT MBO_STATUS mboVecDestroy(MboVec *v);

MBO_EXPORT MBO_STATUS mboVecUnitVector(MboGlobInd n, MboVec v);

MBO_EXPORT MboGlobInd mboVecDim(MboVec v);

MBO_EXPORT MBO_STATUS mboVecGetViewRW(MboVec v, struct MboAmplitude **array);

MBO_EXPORT MBO_STATUS mboVecGetViewR(MboVec v, struct MboAmplitude **array);

MBO_EXPORT MBO_STATUS mboVecReleaseView(MboVec v, struct MboAmplitude **array);

MBO_EXPORT MBO_STATUS mboVecAXPY(struct MboAmplitude *a, MboVec x, MboVec y);

MBO_EXPORT MBO_STATUS mboVecDot(MboVec x, MboVec y, struct MboAmplitude *result);

MBO_EXPORT MBO_STATUS mboVecSwap(MboVec x, MboVec y);

MBO_EXPORT MBO_STATUS mboVecSet(struct MboAmplitude *a, MboVec x);

MBO_EXPORT MBO_STATUS mboVecSetRandom(MboVec x);

MBO_EXPORT MBO_STATUS
mboVecKron(int n, MboLocInd *dims, struct MboAmplitude **vecs, MboVec x);

MBO_EXPORT MBO_STATUS
mboVecMap(int n, MboLocInd *dims,
          void f(int, MboLocInd *, MboLocInd *, void *, struct MboAmplitude *),
          void *ctx, MboVec x);

MBO_EXPORT MBO_STATUS mboVecDuplicate(MboVec x, MboVec *y);

MBO_EXPORT int mboVecCheck(MboVec v);

#ifdef __cplusplus
}
#endif

#endif