coffee
Coronagraph Optimization For Fast Exoplanet Exploration
templatemodule.h File Reference

Function prototypes for templatemodule. More...

Go to the source code of this file.

Functions

INITIALIZATION

Module initialization functions

int_fast8_t init_templatemodule ()
 Initialize module. More...
 
TEMPLATEMODULE - 1. FIRST GROUP OF FUNCTIONS
int templatemodule_examplefunc00 (int mode)
 one-line description of function More can be included here if needed More...
 
TEMPLATEMODULE - 2.1. SECOND GROUP OF FUNCTIONS - SUBGROUP1
int templatemodule_examplefunc01 (float val1, int n1, float *farray)
 one-line description of function More...
 

Detailed Description

Function prototypes for templatemodule.

Author
O. Guyon
Date
Aug 2 2017
Bug:
No known bugs.

Function Documentation

int_fast8_t init_templatemodule ( )

Initialize module.

int templatemodule_examplefunc00 ( int  mode)

one-line description of function More can be included here if needed

Purpose

This function does absolutely nothing useful

Arguments

Parameters
[in]modeINT mode sets up what function does
  • does nothing
  • also does nothing
int templatemodule_examplefunc01 ( float  val1,
int  n1,
float *  farray 
)

one-line description of function

Parameters
[in]val1This parameter does this and that
[in]n1Number of that
[out]farrayOutput array