da/d23/list_8h_source.html

 //

 //  list.h

 //

 //  Authors: Nicolae Mihalache & François Vigneron

 //

 //  This software is released under BSD licence, with an attribution clause (see Licence file).

 //  Please cite the reference below if you use or distribute this software.

 //

 //  • [1] R. Anton, N. Mihalache & F. Vigneron. Fast evaluation of real and complex polynomials. 2022.

 //        https://hal.archives-ouvertes.fr/hal-03820369

 //

 //  Copyright 2022 Univ. Paris-Est Créteil & Univ. de Reims Champagne-Ardenne.

 //


 #ifndef list_h

 #define list_h


 #include "ntypes.h"


 #define LIST_FACTOR 1.2


 #define LIST_TERM 100


  // MARK: data types


  typedef struct {

      deg_t size;

      deg_t count;

      deg_t *k;

      real_t *s;

      bool sorted;

  } list_struct;


  typedef list_struct list_t[1];


  typedef list_struct *list;


  // MARK: macros & functions prototypes


 list list_new(deg_t size);


 bool list_init(list l, deg_t size);


 bool list_free(list l);


 bool list_clear(list l);


 list list_clone(list l);


 bool list_add(list l, deg_t k, real_t s);


 bool list_trim(list l);


 bool list_sort(list l);


 #endif /* list_h */

list_free
bool list_free(list l)
Frees all the memory used by the list l, assuming the struct has been allocated with malloc(),...

list_add
bool list_add(list l, deg_t k, real_t s)
Adds the couple (k,s) at a new position at the end of the list l.

list_trim
bool list_trim(list l)
Trims the list l to minimal size to contain all its elements.

list_init
bool list_init(list l, deg_t size)
Initializes an existing list l with storage space for size numbers.

list_t
list_struct list_t[1]
Practical wrapper for list_struct.
Definition: list.h:46

list_new
list list_new(deg_t size)
Returns a new list of machine real numbers, with storage space for size numbers.

list_clone
list list_clone(list l)
Returns a copy of the list l.

list_clear
bool list_clear(list l)
Frees all the memory used by the list l, but not the list l itself.

list_sort
bool list_sort(list l)
Sorts the list in descending order while preserving couples (k[i],s[i]) for all i.

list
list_struct * list
Convenience pointer to list_struct.
Definition: list.h:49

ntypes.h
Definition of basic types.

real_t
double real_t
The machine number type to use for polynomial analysis and preconditionning.
Definition: ntypes.h:163

deg_t
ulong deg_t
The integer number type to use for polynomial degrees and indexes.
Definition: ntypes.h:128

list_struct
A list of real numbers that can be sorted, while keeping track of original order.
Definition: list.h:35

list_struct::count
deg_t count
the number of elements
Definition: list.h:37

list_struct::k
deg_t * k
indexes, powers, the permutation of the numbers when sorted
Definition: list.h:38

list_struct::s
real_t * s
the list of numbers
Definition: list.h:39

list_struct::size
deg_t size
the memory size allocated
Definition: list.h:36

list_struct::sorted
bool sorted
the state of the list
Definition: list.h:40