src/macros.h File Reference

Header file that defines all macros definitions. More...

#include <stdlib.h>
#include <assert.h>
#include <string.h>

Include dependency graph for macros.h:

This graph shows which files directly or indirectly include this file:


Defines

#define NEW(Ref, Type, Nb)
 Redefine the calloc function.
#define RENEW(Ref, Type, Nb)
 Redefine the realloc function.
#define DESTROY(Ref)
 Redefine the free function.
#define MAX(Aa, Bb)   ((Aa > Bb) ? (Aa) : (Bb))
 Defines a maximum function between 2 numbers.
#define MIN(Aa, Bb)   ((Aa < Bb) ? (Aa) : (Bb))
 Defines a minimum function between 2 numbers.

Detailed Description

Header file that defines all macros definitions.

Author:
Benjamin Grenier-Boley <benjamin.grenier-boley@inria.fr>
Version:
1.02
Date:
September 2008
This file will redefines all macros used in this software like realloc, free, max, min, the score function etc.

Define Documentation

#define DESTROY ( Ref   ) 

#define MAX ( Aa,
Bb   )     ((Aa > Bb) ? (Aa) : (Bb))

Defines a maximum function between 2 numbers.

Parameters:
[in] Aa : First number to compare
[in] Bb : Second number to compare
Returns:
The max number between the 2 numbers
This definition defines a function that will determine the maximum number between two numbers

Referenced by determine_pos_query(), eliminate_redundancy_species(), and score_function().

#define MIN ( Aa,
Bb   )     ((Aa < Bb) ? (Aa) : (Bb))

Defines a minimum function between 2 numbers.

Parameters:
[in] Aa : First number to compare
[in] Bb : Second number to compare
Returns:
The min number between the 2 numbers
This definition defines a function that will determine the minimum number between two numbers

Referenced by determine_pos_query(), and eliminate_redundancy_species().

#define NEW ( Ref,
Type,
Nb   ) 

Value:

Ref = (Type*)calloc((Nb), sizeof(Type));        \
  assert(Ref != NULL)
Redefine the calloc function.

Parameters:
[in,out] Ref : The pointer that needs to be allocated
[in] Type : Type of the pointer
[in] Nb : size that needs to be allocated
This definition defines the calloc function on the pointer "Ref" given of type "Type" and size "Nb" linked with an assert function

Referenced by aln(), calculate_nb_al_function(), call_carnac(), carnac_individual_energy(), check_parameters_validity(), check_species_repetitions(), compare_all_against_ref(), complete_alignments_attributes(), complete_sequences_attributes(), complete_set_sequences(), copy_alignment(), copy_interval_query(), eliminate_redundancy_set(), eliminate_redundancy_species(), get_interesting_regions(), get_sequences(), get_sets_of_sequences(), init_carnac(), main(), maxi_clique_search(), parse_params(), read_alignments_files(), read_file(), read_line(), recursive_search_maxi_clique(), search_naive_clique(), small_in_large(), write_GFF3(), and write_multifasta().

#define RENEW ( Ref,
Type,
Nb   ) 

Value:

Ref = (Type*)realloc(Ref, (Nb) * sizeof(Type)); \
  assert(Ref != NULL)
Redefine the realloc function.

Parameters:
[in,out] Ref : The pointer that needs to be reallocated
[in] Type : Type of the pointer
[in] Nb : Total size that needs to be reallocated
This definition defines the realloc function on the pointer "Ref" given of type "Type" and size "Nb" linked with an assert function

Referenced by carnac_individual_energy(), check_parameters_validity(), check_species_repetitions(), compare_all_against_ref(), complete_sequences_attributes(), eliminate_redundancy_set(), eliminate_redundancy_species(), get_interesting_regions(), get_sequences(), get_sets_of_sequences(), maxi_clique_search(), parse_params(), read_alignments_files(), read_line(), recursive_search_maxi_clique(), and search_naive_clique().


Generated on Mon Sep 22 16:34:10 2008 for matt_ygraph by  doxygen 1.5.5