gd_madd_const man page on OpenSuSE

Man page or keyword search:  
man Server   25941 pages
apropos Keyword Search (all sections)
Output format
OpenSuSE logo
[printable version]

gd_madd_bit(3)			    GETDATA			gd_madd_bit(3)

NAME
       gd_madd_bit,	gd_madd_carray,	    gd_madd_clincom,	gd_madd_const,
       gd_madd_cpolynom,   gd_madd_crecip,   gd_madd_divide,   gd_madd_lincom,
       gd_madd_linterp,	  gd_madd_multiply,   gd_madd_phase,  gd_madd_polynom,
       gd_madd_recip, gd_madd_sbit, gd_madd_string — add a field to a dirfile

SYNOPSIS
       #include <getdata.h>

       int gd_madd_bit(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, int bitnum, int numbits);

       int gd_madd_carray(DIRFILE *dirfile, const char *parent, const char
	      *field_name, gd_type_t const_type, size_t array_len, gd_type_t
	      data_type, void *value);

       int gd_madd_clincom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int n_fields, const char **in_fields, const double
	      complex *cm, const double complex *cb);

       int gd_madd_const(DIRFILE *dirfile, const char *parent, const char
	      *field_name, gd_type_t const_type, gd_type_t data_type, void
	      *value);

       int gd_madd_cpolynom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int poly_ord, const char *in_field, const double
	      complex *ca);

       int gd_madd_crecip(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, double complex cdividend, int
	      fragment_index);

       int gd_madd_divide(DIRFILE *dirfile, const char *parent, const char
	      *field_name,  const char *in_field1, const char *in_field2);

       int gd_madd_lincom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int n_fields, const char **in_fields, const double
	      *m, const double *b);

       int gd_madd_linterp(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, const char *table);

       int gd_madd_mplex(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, const char *count_field, int
	      count_val, int period);

       int gd_madd_multiply(DIRFILE *dirfile, const char *parent, const char
	      *field_name,  const char *in_field1, const char *in_field2);

       int gd_madd_polynom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int poly_ord, const char *in_field, const double
	      *a);

       int gd_madd_phase(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, gd_shift_t shift);

       int gd_madd_recip(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, double dividend, int
	      fragment_index);

       int gd_madd_sbit(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, int bitnum, int numbits);

       int gd_madd_string(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *value);

       int gd_madd_window(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, const char *check_field,
	      gd_windop_t windop, gd_triplet_t threshold);

DESCRIPTION
       These  functions	 add  a	 new metafield of the indicated type under the
       parent field given by parent in the dirfile specified by dirfile.

       In all of these calls, field_name indicates the name of the field to be
       added.	It  should  not	 be the full <parent-field>/<meta-field> field
       code.  The meaning and valid types of other arguments may  be  obtained
       from the gd_entry(3) and dirfile-format(5) manual pages.

       The gd_madd_clincom() and gd_madd_cpolynom() functions are identical to
       gd_madd_lincom() and gd_madd_polynom(), except they take complex scalar
       parameters, instead of purely real values.

       The  gd_madd_lincom()  and gd_madd_clincom() functions take pointers to
       three arrays of	length	n_fields  containing  the  input  field	 names
       (in_fields),  the  gain	factors	 (m or cm), and the offset terms (b or
       cb).  Similarly, gd_madd_polynom() and gd_madd_cpolynom() take an array
       of  length  poly_ord  + 1 containing the polynomial co-efficients (a or
       ca).

       The gd_madd_string(),  gd_madd_carray,  and  gd_madd_const()  functions
       both  add  the  field  and  set	the  value of the field to value.  For
       gd_madd_const() and gd_madd_carray(), the const_type argument specifies
       the storage type for the const, while data_type specifies the data type
       of the value pointed to by value.

       The gd_shift_t type is a signed 64-bit integer type.  The  gd_triplet_t
       type is defined as:

	   typedef union {
	     gd_int64_t i;
	     gd_uint64_t u;
	     double r;
	   } gd_triplet_t;

       Which element of this gd_triplet_t union to set depends on the operator
       selected for the WINDOW field.  See gd_entry(3) for details.

       All fields added with this interface must contain numerical parameters.
       Fields  with  scalar  fields  as	 parameters cannot be added with these
       functions.   Those  fields   must   be	added	with   gd_madd(3)   or
       gd_madd_spec(3).	 See gd_add_bit(3), &c. for an alternate way of adding
       metafields with explicit parameters.

       See  NOTES  below   for	 information   on   using   gd_madd_clincom(),
       gd_madd_cpolynom(), and gd_madd_crecip() in the C89 GetData API.

RETURN VALUE
       On  success, any of these functions returns zero.   On error, -1 is re‐
       turned and the dirfile error is set to a non-zero error value.	Possi‐
       ble error values are:

       GD_E_ACCMODE
	       The specified dirfile was opened read-only.

       GD_E_ALLOC
	       The library was unable to allocate memory.

       GD_E_BAD_CODE
	       The  field_name	argument  contained invalid characters. Alter‐
	       nately, the parent field code was not found, or was  already  a
	       metafield.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       GD_E_BAD_ENTRY
	       One or more of the field parameters specified was invalid.

       GD_E_BAD_TYPE
	       The  data_type  or const_type argument provided to gd_madd_con‐
	       st() or gd_madd_carray() was invalid.

       GD_E_DUPLICATE
	       The field_name provided duplicated that of an already  existing
	       field.

       GD_E_PROTECTED
	       The metadata of the fragment was protected from change.

       The  dirfile error may be retrieved by calling gd_error(3).  A descrip‐
       tive error string for the last error encountered can be obtained from a
       call to gd_error_string(3).

NOTES
       The  C89	 GetData  API  provides different prototypes for gd_madd_clin‐
       com(), gd_madd_cpolynom(), and gd_madd_crecip():

       #define GD_C89_API #include <getdata.h>

       int gd_madd_clincom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int n_fields, const char **in_fields, const double
	      *cm, const double *cb);

       int gd_madd_cpolynom(DIRFILE *dirfile, const char *parent, const char
	      *field_name, int poly_ord, const char *in_field, const double
	      *ca);

       int gd_madd_crecip(DIRFILE *dirfile, const char *parent, const char
	      *field_name, const char *in_field, double cdividend[2], int
	      fragment_index);

       In this case, the array pointers passed as cm, cb  or  ca  should  have
       twice  as  many	(purely real) elements, consisting of alternating real
       and imaginary parts for the complex data.  For example, ca[0] should be
       the  real  part	of the first co-efficient, ca[1] the imaginary part of
       the first co-efficient, ca[2] the real part of the second co-efficient,
       ca[3]  the imaginary part of the second co-efficient, and so on.	 Simi‐
       larly, the cdividend parameter becomes  a  double  precision  array  of
       length two.

SEE ALSO
       gd_add_bit(3),	gd_add_const(3),  gd_add_divide(3),  gd_add_lincom(3),
       gd_add_linterp(3),	  gd_add_mplex(3),	   gd_add_multiply(3),
       gd_add_phase(3),	 gd_add_polynom(3), gd_add_recip(3), gd_add_string(3),
       gd_add_windop(3),   gd_entry(3),	   gd_error(3),	   gd_error_string(3),
       gd_madd(3),  gd_madd_spec(3), gd_metaflush(3), gd_open(3), dirfile-for‐
       mat(5)

Version 0.8.0			 1 April 2012			gd_madd_bit(3)
[top]

List of man pages available for OpenSuSE

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net