starsh-particles.h

Go to the documentation of this file.

#ifndef __STARSH_PARTICLES_H__
#define __STARSH_PARTICLES_H__

// Add definitions for size_t, va_list and STARSH_kernel
#include "starsh.h"
// Add definitions for FILE type and functions
#include <stdio.h>
// Add definition for uint32_t
#include <stdint.h>

typedef struct starsh_particles

{
    STARSH_int count;
    int ndim;
    double *point;
} STARSH_particles;



enum STARSH_PARTICLES_PLACEMENT

{
    STARSH_PARTICLES_RAND = 1,
    //STARSH_PARTICLES_RANDN = 2,
    STARSH_PARTICLES_UNIFORM = 3,
    STARSH_PARTICLES_RANDGRID = 4,
    //STARSH_PARTICLES_RANDNGRID = 5,
    STARSH_PARTICLES_QUASIUNIFORM1 = 6,
    STARSH_PARTICLES_QUASIUNIFORM2 = 7,
    STARSH_PARTICLES_OBSOLETE1 = -1,
    STARSH_PARTICLES_OBSOLETE2 = -2,
    STARSH_PARTICLES_OBSOLETE3 = -3,
    // for 1D, 2D, and 3D cases -- use each location twice. (Parsimonious bivaritae case1).
    STARSH_PARTICLES_OBSOLETE4 = -4,
    // for 1D, 2D, and 3D cases-- use each location twice. (Parsimonious bivaritae case2).
};

int starsh_particles_new(STARSH_particles **data, STARSH_int count, int ndim);
int starsh_particles_init(STARSH_particles **data, STARSH_int count, int ndim,
        double *point);
void starsh_particles_free(STARSH_particles *data);

int starsh_particles_generate(STARSH_particles **data, STARSH_int count,
        int ndim, enum STARSH_PARTICLES_PLACEMENT ptype);

int starsh_particles_generate_rand(STARSH_particles **data, STARSH_int count,
        int ndim);
int starsh_particles_generate_randgrid(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_uniform(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_quasiuniform1(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_quasiuniform2(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_obsolete1(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_obsolete2(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_obsolete3(STARSH_particles **data,
        STARSH_int count, int ndim);
int starsh_particles_generate_obsolete4(STARSH_particles **data,
        STARSH_int count, int ndim);

int starsh_particles_read_from_file(STARSH_particles **data, const char *fname,
        const enum STARSH_FILE_TYPE ftype);
int starsh_particles_read_from_file_pointer(STARSH_particles **data,
        FILE *fp, const enum STARSH_FILE_TYPE ftype);
int starsh_particles_read_from_file_pointer_ascii(STARSH_particles **data,
        FILE *fp);
int starsh_particles_read_from_file_pointer_binary(STARSH_particles **data,
        FILE *fp);

int starsh_particles_write_to_file(const STARSH_particles *data,
        const char *fname, const enum STARSH_FILE_TYPE ftype);
int starsh_particles_write_to_file_pointer(const STARSH_particles *data,
        FILE *fp, const enum STARSH_FILE_TYPE ftype);
int starsh_particles_write_to_file_pointer_ascii(const STARSH_particles *data,
        FILE *fp);
int starsh_particles_write_to_file_pointer_binary(const STARSH_particles *data,
        FILE *fp);

int starsh_particles_zsort_inplace(STARSH_particles *data);

#endif // __STARSH_PARTICLES_H__