Fix integrity check for context

[openscop.git] / source / relation.c

    /*+-----------------------------------------------------------------**
     **                       OpenScop Library                          **
     **-----------------------------------------------------------------**
     **                           relation.c                            **
     **-----------------------------------------------------------------**
     **                   First version: 30/04/2008                     **
     **-----------------------------------------------------------------**

 
 *****************************************************************************
 * OpenScop: Structures and formats for polyhedral tools to talk together    *
 *****************************************************************************
 *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
 *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
 *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
 *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
 *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
 *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
 *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
 *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
 *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
 *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
 *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
 *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
 *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
 *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
 *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
 *                                                                           *
 * Copyright (C) 2008 University Paris-Sud 11 and INRIA                      *
 *                                                                           *
 * (3-clause BSD license)                                                    *
 * Redistribution and use in source  and binary forms, with or without       *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 * 3. The name of the author may not be used to endorse or promote products  *
 *    derived from this software without specific prior written permission.  *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
 *                                                                           *
 * OpenScop Library, a library to manipulate OpenScop formats and data       *
 * structures. Written by:                                                   *
 * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
 * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
 *                                                                           *
 *****************************************************************************/


# include <stdlib.h>
# include <stdio.h>
# include <string.h>
# include <ctype.h>
# include <openscop/relation.h>


/*+***************************************************************************
 *                          Structure display function                       *
 *****************************************************************************/


/**
 * openscop_relation_print_structure function:
 * this function displays a openscop_relation_t structure (*relation) into a
 * file (file, possibly stdout) in a way that trends to be understandable.
 * It includes an indentation level (level) in order to work with others
 * print_structure functions.
 * \param[in] file     File where informations are printed.
 * \param[in] relation The relation whose information have to be printed.
 * \param[in] level    Number of spaces before printing, for each line.
 */
void
openscop_relation_print_structure(FILE * file, openscop_relation_p relation,
                                  int level)
{
  int i, j, first = 1;

  // Go to the right level.
  for (j = 0; j < level; j++)
    fprintf(file, "|\t");

  if (relation != NULL)
    fprintf(file, "+-- openscop_relation_t\n");
  else
    fprintf(file, "+-- NULL relation\n");

  while (relation != NULL)
  {
    if (! first)
    {
      // Go to the right level.
      for (j = 0; j < level; j++)
        fprintf(file, "|\t");
      fprintf(file, "|   openscop_relation_t\n");
    }
    else
      first = 0;

    // A blank line
    for(j = 0; j <= level; j++)
      fprintf(file, "|\t");
    fprintf(file, "%d %d %d %d %d %d\n",
            relation->nb_rows,        relation->nb_columns,
            relation->nb_output_dims, relation->nb_input_dims,
            relation->nb_local_dims,  relation->nb_parameters);

    // Display the relation.
    for (i = 0; i < relation->nb_rows; i++)
    {
      for (j = 0; j <= level; j++)
        fprintf(file, "|\t");

      fprintf(file, "[ ");

      for (j = 0; j < relation->nb_columns; j++)
      {
        SCOPINT_print(file, OPENSCOP_FMT, relation->m[i][j]);
        fprintf(file, " ");
      }

      fprintf(file, "]\n");
    }

    relation = relation->next;

    // Next line.
    if (relation != NULL)
    {
      for (j = 0; j <= level; j++)
        fprintf(file, "|\t");
      fprintf(file, "|\n");
      for (j = 0; j <= level; j++)
        fprintf(file, "|\t");
      fprintf(file, "V\n");
    }
  }

  // The last line.
  for (j = 0; j <= level; j++)
    fprintf(file, "|\t");
  fprintf(file, "\n");
}


/**
 * openscop_relation_print function:
 * this function prints the content of a openscop_relation_t structure
 * (*relation) into a file (file, possibly stdout).
 * \param[in] file     File where informations are printed.
 * \param[in] relation The relation whose information have to be printed.
 */
void
openscop_relation_print(FILE * file, openscop_relation_p relation)
{
  openscop_relation_print_structure(file, relation, 0);
}



/**
 * openscop_relation_expression_element function:
 * this function returns a string containing the printing of a value (possibly
 * an iterator or a parameter with its coefficient or a constant).
 * \param[in]     val   The coefficient or constant value.
 * \param[in,out] first Pointer to a boolean set to 1 if the current value is
 *                      the first of an expresion, 0 otherwise (maybe updated).
 * \param[in]     cst   A boolean set to 1 if the value is a constant,
 *                      0 otherwise.
 * \param[in]     name  String containing the name of the element.
 * \return A string that contains the printing of a value.
 */
static
char *
openscop_relation_expression_element(openscop_int_t val, int * first, int cst,
                                     char * name)
{
  char * sval, * body, * temp;

  temp = (char *)malloc(OPENSCOP_MAX_STRING * sizeof(char));
  body = (char *)malloc(OPENSCOP_MAX_STRING * sizeof(char));
  sval = (char *)malloc(OPENSCOP_MAX_STRING * sizeof(char));
  body[0] = '\0';
  sval[0] = '\0';

  // statements for the 'normal' processing.
  if (SCOPINT_notzero_p(val) && (!cst))
  {
    if ((*first) || SCOPINT_neg_p(val))
    {
      if (SCOPINT_one_p(val))           // case 1
        sprintf(sval, "%s", name);
      else
      {
        if (SCOPINT_mone_p(val))        // case -1
          sprintf(sval, "-%s", name);
        else                            // default case
        {
          SCOPINT_sprint(sval, OPENSCOP_FMT_TXT, val);
          sprintf(temp, "*%s", name);
          strcat(sval, temp);
        }
      }
      *first = 0;
    }
    else
    {
      if (SCOPINT_one_p(val))
        sprintf(sval, "+%s", name);
      else
      {
        sprintf(sval, "+");
        SCOPINT_sprint(temp, OPENSCOP_FMT_TXT, val);
        strcat(sval, temp);
        sprintf(temp, "*%s", name);
        strcat(sval, temp);
      }
    }
  }
  else
  {
    if (cst)
    {
      if ((SCOPINT_zero_p(val) && (*first)) || SCOPINT_neg_p(val))
        SCOPINT_sprint(sval, OPENSCOP_FMT_TXT, val);
      if (SCOPINT_pos_p(val))
      {
        if (!(*first))
        {
          SCOPINT_sprint(sval, "+"OPENSCOP_FMT_TXT, val); // Block macro !
        }
        else
          SCOPINT_sprint(sval, OPENSCOP_FMT_TXT, val);
      }
    }
  }
  free(temp);
  free(body);

  return(sval);
}


/**
 * openscop_relation_expression function:
 * this function returns a string corresponding to an affine expression
 * stored at the "row"^th row of the relation pointed by "relation".
 * \param[in] relation A set of linear expressions.
 * \param[in] row      The row corresponding to the expression.
 * \param[in] names    The textual names of the various elements. Is is
 *                     important that names->nb_parameters is exact if the
 *                     matrix representation is used. Set to NULL if
 *                     printing comments is not needed.
 * \return A string that contains the printing of an affine expression.
 */
static
char *
openscop_relation_expression(openscop_relation_p relation, int row,
                             openscop_names_p names)
{
  int i, first = 1;
  char * sline, * sval;

  sline = (char *)malloc(OPENSCOP_MAX_STRING * sizeof(char)) ;
  sline[0] = '\0' ;

  // First the iterator part.
  for (i = 1; i <= names->nb_iterators; i++)
  {
    sval = openscop_relation_expression_element(relation->m[row][i], 
                                            &first, 0, names->iterators[i-1]);
    strcat(sline, sval);
    free(sval);
  }

  // Next the local dims part.
  for (i = names->nb_iterators + 1;
       i <= names->nb_iterators + names->nb_localdims; i++)
  {
    sval = openscop_relation_expression_element(relation->m[row][i], &first, 0,
                                names->localdims[i - names->nb_iterators - 1]);
    strcat(sline, sval);
    free(sval);
  }

  // Next the parameter part.
  for (i = names->nb_iterators + names->nb_localdims + 1;
       i <= names->nb_iterators + names->nb_localdims + names->nb_parameters;
       i++)
  {
    sval = openscop_relation_expression_element(relation->m[row][i], &first, 0,
        names->parameters[i - names->nb_iterators - names->nb_localdims - 1]);
    strcat(sline, sval);
    free(sval);
  }

  // Finally the constant part (yes, I reused it).
  sval = openscop_relation_expression_element(relation->m[row][i],
                                              &first, 1, NULL);
  strcat(sline, sval);
  free(sval);

  return sline;
}


/**
 * openscop_relation_get_array_id internal function:
 * this function returns the array identifier when the relation provided
 * as parameter corresponds to an access function.
 * \param[in] relation The access function.
 * \return The accessed array identifier.
 */
static
int
openscop_relation_get_array_id(openscop_relation_p relation)
{
  if (relation == NULL)
  {
    fprintf(stderr, "[OpenScop] Error: cannot find nb_arrays "
                    "in a NULL relation.\n");
    exit(1);
  }

  if (relation->nb_local_dims == OPENSCOP_UNDEFINED)
  {
    // Matrix representation case.
    if ((relation->nb_rows < 1) || (relation->nb_columns < 1))
    {
      fprintf(stderr, "[OpenScop] Error: not enough rows or columns "
                      "to extract nb_arrays.\n");
      exit(1);
    }
    return SCOPINT_get_si(relation->m[0][0]);
  }
  else
  {
    // Relation representation case.
    if ((relation->nb_rows < 1) || (relation->nb_columns < 2))
    {
      fprintf(stderr, "[OpenScop] Error: not enough rows or columns "
                      "to extract nb_arrays.\n");
      exit(1);
    }
    // TODO: do something more general
    return SCOPINT_get_si(relation->m[0][relation->nb_columns - 1]);
  }
}


/**
 * openscop_relation_print_openscop function:
 * this function prints the content of a openscop_relation_t structure
 * (*relation) into a file (file, possibly stdout) in the OpenScop format.
 * \param[in] file     File where informations are printed.
 * \param[in] relation The relation whose information has to be printed.
 * \param[in] type     Semantics about this relation (domain, access...).
 * \param[in] names    The textual names of the various elements. Is is
 *                     important that names->nb_parameters is exact if the
 *                     matrix representation is used. Set to NULL if printing
 *                     comments is not needed.
 */
void
openscop_relation_print_openscop(FILE * file, openscop_relation_p relation,
                                 int type,    openscop_names_p names)
{
  int i, j, k;
  int part, nb_parts;
  char * expression;
  openscop_relation_p r;

  if (relation == NULL)
  {
    fprintf(stderr, "[OpenScop] Warning: asked to print a NULL relation.\n");
    fprintf(file, "# NULL relation\n");
    return;
  }

  // TODO: check whether there are enough names or not, if not set to NULL.
  // TODO: if names are not textual, set to NULL.
 
  // Count the number of parts in the union and print it if it is not 1.
  r = relation;
  nb_parts = 0;
  while (r != NULL)
  {
    nb_parts++;
    r = r->next;
  }
  if (nb_parts > 1)
    fprintf(file, "# Union with %d parts\n%d\n", nb_parts, nb_parts);

  // Print each part of the union.
  for (part = 1; part <= nb_parts; part++)
  {
    if (nb_parts > 1)
      fprintf(file, "# Union part No.%d\n", part);
    if ((relation->nb_output_dims == OPENSCOP_UNDEFINED) && 
        (relation->nb_input_dims  == OPENSCOP_UNDEFINED) && 
        (relation->nb_local_dims  == OPENSCOP_UNDEFINED) && 
        (relation->nb_parameters  == OPENSCOP_UNDEFINED)) 
      fprintf(file, "%d %d\n", relation->nb_rows, relation->nb_columns);
    else
      fprintf(file, "%d %d %d %d %d %d\n",
              relation->nb_rows,        relation->nb_columns,
              relation->nb_output_dims, relation->nb_input_dims,
              relation->nb_local_dims,  relation->nb_parameters);

    for (i = 0; i < relation->nb_rows; i++)
    {
      for (j = 0; j < relation->nb_columns; j++)
      {
        SCOPINT_print(file, OPENSCOP_FMT, relation->m[i][j]);
        fprintf(file, " ");
      }

      if (type == OPENSCOP_TYPE_DOMAIN)
      {
        expression = openscop_relation_expression(relation, i, names);
        fprintf(file, "   ## %s", expression);
        free(expression);
        if (SCOPINT_zero_p(relation->m[i][0]))
          fprintf(file, " == 0");
        else
          fprintf(file, " >= 0");
      }

      if (type == OPENSCOP_TYPE_SCATTERING)
      {
        expression = openscop_relation_expression(relation, i, names);
        fprintf(file, "   ## %s", expression);
        free(expression);
      }

      if (type == OPENSCOP_TYPE_ACCESS)
      {
        //TODO: works only for matrix: use openscop_relation_get_array_id
        if (SCOPINT_notzero_p(relation->m[i][0]))
        {
          if (strncmp(names->arrays[SCOPINT_get_si(relation->m[i][0]) - 1],
                OPENSCOP_FAKE_ARRAY, strlen(OPENSCOP_FAKE_ARRAY)))
            fprintf(file, "   ## %s",
                    names->arrays[SCOPINT_get_si(relation->m[i][0]) - 1]);
          k = i;
          do
          {
            expression = openscop_relation_expression(relation, k, names);
            fprintf(file, "[%s]", expression);
            free(expression);
            k++;
          }
          while ((k < relation->nb_rows) &&
                 SCOPINT_zero_p(relation->m[k][0]))
            ;
        }
        else
          fprintf(file, "   ##");
      }

      fprintf(file, "\n");
    }
    relation = relation->next;
  }
}


/*****************************************************************************
 *                               Reading function                            *
 *****************************************************************************/


/**
 * openscop_relation_read function:
 * this function reads a relation into a file (foo, posibly stdin) and
 * returns a pointer this relation.
 * \param[in] file The input stream.
 * \return A pointer to the relation structure that has been read.
 */
openscop_relation_p
openscop_relation_read(FILE * foo)
{
  int i, j, k, n, read = 0;
  int nb_rows, nb_columns;
  int nb_output_dims, nb_input_dims, nb_local_dims, nb_parameters;
  int nb_union_parts = 1;
  int may_read_nb_union_parts = 1;
  int read_properties = 1;
  int first = 1;
  char * c, s[OPENSCOP_MAX_STRING], str[OPENSCOP_MAX_STRING];
  openscop_relation_p relation, relation_union = NULL, previous = NULL;
  openscop_int_t * p = NULL;

  // Read each part of the union (the number of parts may be updated inside)
  for (k = 0; k < nb_union_parts; k++)
  {
    // Read the number of union parts or the properties of the union part
    while (read_properties)
    {
      read_properties = 0;

      // Read relation properties.
      c = openscop_util_skip_blank_and_comments(foo, s);
      read = sscanf(c, " %d %d %d %d %d %d", &nb_rows, &nb_columns,
                                             &nb_output_dims, &nb_input_dims,
                                             &nb_local_dims, &nb_parameters);
    
      if (((read != 1) && (read != 2) && (read != 6)) ||
          ((read == 1) && (may_read_nb_union_parts != 1)))
      {
        fprintf(stderr, "[OpenScop] Error:: badly formated relation.\n");
        exit(1);
      }
      if (read == 1)
      {
        // Only one number means a union and is the number of parts.
        nb_union_parts = nb_rows;
        if (nb_union_parts < 1)
        {
          fprintf(stderr, "[OpenScop] Error: negative nb of union parts.\n");
          exit(1);
        }
        // Allow to read the properties of the first part of the union.
        read_properties = 1;
      }
      if (read == 2)
      {
        nb_output_dims = OPENSCOP_UNDEFINED;
        nb_input_dims  = OPENSCOP_UNDEFINED;
        nb_local_dims  = OPENSCOP_UNDEFINED;
        nb_parameters  = OPENSCOP_UNDEFINED;
      }

      may_read_nb_union_parts = 0;
    }

    // Allocate the union part and fill its properties.
    relation = openscop_relation_malloc(nb_rows, nb_columns);
    relation->nb_output_dims = nb_output_dims;
    relation->nb_input_dims  = nb_input_dims;
    relation->nb_local_dims  = nb_local_dims;
    relation->nb_parameters  = nb_parameters;

    // Read the matrix of constraints.
    if ((relation->nb_rows != 0) && (relation->nb_columns != 0))
      p = relation->m[0];

    for (i = 0; i < relation->nb_rows; i++)
    {
      c = openscop_util_skip_blank_and_comments(foo, s);
      if (c == NULL)
      {
        fprintf(stderr, "[OpenScop] Error: not enough rows.\n");
        exit(1);
      }

      for (j = 0; j < relation->nb_columns; j++)
      {
        if (c == NULL || *c == '#' || *c == '\n')
        {
          fprintf(stderr, "[OpenScop] Error: not enough columns.\n");
          exit(1);
        }
        if (sscanf(c, "%s%n", str, &n) == 0)
        {
          fprintf(stderr, "[OpenScop] Error: not enough rows.\n");
          exit(1);
        }
#if defined(OPENSCOP_INT_T_IS_MP)
        long long val;
        if (sscanf(str, "%lld", &val) == 0)
        {
          fprintf(stderr, "[OpenScop] Error: failed to read an integer.\n");
          exit(1);
        }
        mpz_set_si(*p++, val);
#else
        if (sscanf(str, OPENSCOP_FMT_TXT, p++) == 0)
        {
          fprintf(stderr, "[OpenScop] Error: failed to read an integer.\n");
          exit(1);
        }
#endif
        c += n;
      }
    }
    
    // Build the linked list of union parts.
    if (first == 1)
    {
      relation_union = relation;
      first = 0;
    }
    else
      previous->next = relation;

    previous = relation;
    read_properties = 1;
  }

  return relation_union;
}


/*+***************************************************************************
 *                    Memory allocation/deallocation function                *
 *****************************************************************************/


/**
 * openscop_relation_malloc function:
 * this function allocates the memory space for a openscop_relation_t
 * structure and sets its fields with default values. Then it returns a
 * pointer to the allocated space.
 * \param[in] nb_rows    The number of row of the relation to allocate.
 * \param[in] nb_columns The number of columns of the relation to allocate.
 * \return A pointer to an empty relation with fields set to default values
 *         and a ready-to-use constraint matrix.
 */
openscop_relation_p
openscop_relation_malloc(int nb_rows, int nb_columns)
{
  openscop_relation_p relation;
  openscop_int_t ** p, * q;
  int i, j;

  relation = (openscop_relation_p)malloc(sizeof(openscop_relation_t));
  if (relation == NULL)
  {
    fprintf(stderr, "[OpenScop] Error: memory Overflow.\n");
    exit(1);
  }
  
  relation->nb_rows        = nb_rows;
  relation->nb_columns     = nb_columns;
  relation->nb_output_dims = OPENSCOP_UNDEFINED;
  relation->nb_input_dims  = OPENSCOP_UNDEFINED;
  relation->nb_parameters  = OPENSCOP_UNDEFINED;
  relation->nb_local_dims  = OPENSCOP_UNDEFINED;
  
  if ((nb_rows == 0) || (nb_columns == 0) ||
      (nb_rows == OPENSCOP_UNDEFINED) || (nb_columns == OPENSCOP_UNDEFINED)) 
    relation->m = NULL;
  else
  {
    p = (openscop_int_t **)malloc(nb_rows * sizeof(openscop_int_t *));
    if (p == NULL)
    {
      fprintf(stderr, "[OpenScop] Error: memory Overflow.\n");
      exit(1);
    }
    q = (openscop_int_t *)malloc(nb_rows*nb_columns*sizeof(openscop_int_t));
    if (q == NULL)
    {
      fprintf(stderr, "[OpenScop] Error: memory Overflow.\n");
      exit(1);
    }
    relation->m = p;
    for (i = 0; i < nb_rows; i++)
    {
      *p++ = q;
      for (j = 0; j < nb_columns; j++)
        SCOPINT_init_set_si(*(q+j),0);
      q += nb_columns;
    }
  }
  
  relation->next = NULL;
  
  return relation;
}


/**
 * openscop_relation_free_inside function:
 * this function frees the allocated memory for the inside of a
 * openscop_relation_t structure, i.e. only m.
 * \param[in] relation The pointer to the relation we want to free internals.
 */
void
openscop_relation_free_inside(openscop_relation_p relation)
{
  int i, nb_elements;
  openscop_int_t * p;

  if (relation == NULL)
    return;

  nb_elements = relation->nb_rows * relation->nb_columns;
  
  if (nb_elements > 0)
    p = relation->m[0];
  
  for (i = 0; i < nb_elements; i++)
    SCOPINT_clear(*p++);

  if (relation->m != NULL)
  {
    if (nb_elements > 0)
      free(relation->m[0]);
    free(relation->m);
  }
}


/**
 * openscop_relation_free function:
 * this function frees the allocated memory for a openscop_relation_t
 * structure.
 * \param[in] relation The pointer to the relation we want to free.
 */
void
openscop_relation_free(openscop_relation_p relation)
{
  openscop_relation_p tmp;
  
  if (relation == NULL)
    return;

  while (relation != NULL)
  {
    tmp = relation->next;
    openscop_relation_free_inside(relation);
    free(relation);
    relation = tmp;
  }
}


/*+***************************************************************************
 *                            Processing functions                           *
 *****************************************************************************/


/**
 * openscop_relation_is_matrix function:
 * this function returns 1 if the relation provided as parameter corresponds
 * to a "matrix" representation (see documentation), -1 if it is NULL and
 * 0 in all other cases.
 * \param[in] relation The relation we want to know if it is a matrix or not.
 * \return 1 if the relation has "matrix" representation, -1 if it is NULL,
 *         0 in all other cases.
 */
int
openscop_relation_is_matrix(openscop_relation_p relation)
{
  if (relation == NULL)
    return -1;
  
  // A relation has matrix representation if all nb_local_dims fields
  // of all parts of the union is OPENSCOP_UNDEFINED.
  while (relation != NULL)
  {
    if (relation->nb_local_dims != OPENSCOP_UNDEFINED)
      return 0;
    
    relation = relation->next;
  }

  return 1;
}


/**
 * openscop_relation_ncopy function:
 * this functions builds and returns a "hard copy" (not a pointer copy) of a
 * openscop_relation_t data structure such that the copy is restricted to the
 * "n" first rows of the relation. This applies to all the parts in the case
 * of a relation union.
 * \param[in] relation The pointer to the relation we want to copy.
 * \param[in] n        The number of row of the relation we want to copy (the
 *                     special value -1 means "all the rows").
 * \return A pointer to the full copy of the relation union restricted to the
 *         first n rows of constraint matrix for each part of the union.
 */
openscop_relation_p
openscop_relation_ncopy(openscop_relation_p relation, int n)
{
  int i, j;
  int first = 1, all_rows = 0;
  openscop_relation_p copy = NULL, node, previous = NULL;

  if (n == -1)
    all_rows = 1;

  while (relation != NULL)
  {
    if (all_rows)
      n = relation->nb_rows;

    if (n > relation->nb_rows)
    {
      fprintf(stderr,"[OpenScop] Error: not enough rows in the relation\n");
      exit(1);
    }

    node = openscop_relation_malloc(n, relation->nb_columns);
    node->nb_output_dims = relation->nb_output_dims;
    node->nb_input_dims  = relation->nb_input_dims;
    node->nb_local_dims  = relation->nb_local_dims;
    node->nb_parameters  = relation->nb_parameters;

    for (i = 0; i < n; i++)
      for (j = 0; j < relation->nb_columns; j++)
        SCOPINT_assign(node->m[i][j], relation->m[i][j]);
  
    if (first)
    {
      first = 0;
      copy = node;
      previous = node;
    }
    else
    {
      previous->next = node;
      previous = previous->next;
    }

    relation = relation->next;
  }

  return copy;
}


/**
 * openscop_relation_copy function:
 * this function builds and returns a "hard copy" (not a pointer copy) of an
 * openscop_relation_t data structure (the full union of relation).
 * \param[in] relation The pointer to the relation we want to copy.
 * \return A pointer to the copy of the union of relations.
 */
openscop_relation_p
openscop_relation_copy(openscop_relation_p relation)
{
  if (relation == NULL)
    return NULL;

  return openscop_relation_ncopy(relation, -1);
}


/**
 * openscop_relation_replace_vector function:
 * this function replaces the "row"^th row of a relation "relation" with the
 * vector "vector". It directly updates the relation union part pointed
 * by "relation" and this part only.
 * \param[in,out] relation The relation we want to replace a row.
 * \param[in]     vector   The vector that will replace a row of the relation.
 * \param[in]     row      The row of the relation to be replaced.
 */
void
openscop_relation_replace_vector(openscop_relation_p relation,
                                 openscop_vector_p vector, int row)
{
  int i;

  if ((relation == NULL) || (vector == NULL) ||
      (relation->nb_columns != vector->size) ||
      (row >= relation->nb_rows) || (row < 0))
  {
    fprintf(stderr,"[OpenScop] Error: vector cannot replace relation row.\n");
    exit(1);
  }

  for (i = 0; i < vector->size; i++)
    SCOPINT_assign(relation->m[row][i], vector->v[i]);
}


/**
 * openscop_relation_add_vector function:
 * this function adds (meaning, +) a vector to the "row"^th row of a
 * relation "relation". It directly updates the relation union part pointed
 * by "relation" and this part only.
 * \param[in,out] relation The relation we want to add a vector to a row.
 * \param[in]     vector   The vector that will replace a row of the relation.
 * \param[in]     row      The row of the relation to be replaced.
 */
void
openscop_relation_add_vector(openscop_relation_p relation,
                             openscop_vector_p vector,
                             int row)
{
  int i;

  if ((relation == NULL) || (vector == NULL) ||
      (relation->nb_columns != vector->size) ||
      (row >= relation->nb_rows) || (row < 0))
  {
    fprintf(stderr,"[OpenScop] Error: vector cannot be added to relation.\n");
    exit(1);
  }

  if (SCOPINT_get_si(relation->m[row][0]) == 0)
    SCOPINT_assign(relation->m[row][0], vector->v[0]);
  for (i = 1; i < vector->size; i++)
    SCOPINT_addto(relation->m[row][i], relation->m[row][i], vector->v[i]);
}


/**
 * openscop_relation_sub_vector function:
 * this function subtracts the vector "vector" to the "row"^th row of
 * a relation "relation. It directly updates the relation union part pointed
 * by "relation" and this part only.
 * \param[in,out] relation The relation where to subtract a vector to a row.
 * \param[in]     vector   The vector to subtract to a relation row.
 * \param[in]     row      The row of the relation to subtract the vector.
 */
void
openscop_relation_sub_vector(openscop_relation_p relation,
                             openscop_vector_p vector,
                             int row)
{
  int i;

  if ((relation == NULL) || (vector == NULL) ||
      (relation->nb_columns != vector->size) ||
      (row >= relation->nb_rows) || (row < 0))
  {
    fprintf(stderr,"[OpenScop] Error: vector cannot be subtracted to row.\n");
    exit(1);
  }

  if (SCOPINT_get_si(relation->m[row][0]) == 0)
    SCOPINT_assign(relation->m[row][0], vector->v[0]);
  for (i = 1; i < vector->size; i++)
    SCOPINT_subtract(relation->m[row][i], relation->m[row][i], vector->v[i]);
}


/**
 * openscop_relation_insert_vector function:
 * this function inserts a new row corresponding to the vector "vector" to
 * the relation "relation" by inserting it at the "row"^th row. It directly
 * updates the relation union part pointed by "relation" and this part only.
 * If "vector" (or "relation") is NULL, the relation is left unmodified.
 * \param[in,out] relation The relation we want to extend.
 * \param[in]     vector   The vector that will be added relation.
 * \param[in]     row      The row where to insert the vector.
 */
void
openscop_relation_insert_vector(openscop_relation_p relation,
                                openscop_vector_p vector, 
                                int row)
{
  openscop_relation_p temp;

  temp = openscop_relation_from_vector(vector);
  openscop_relation_insert_relation(relation, temp, row);
  openscop_relation_free(temp);
}


/**
 * openscop_relation_from_vector function:
 * this function converts a vector "vector" to a relation with a single row
 * and returns a pointer to that relation.
 * \param[in] vector The vector to convert to a relation.
 * \return A pointer to a relation resulting from the vector conversion.
 */
openscop_relation_p
openscop_relation_from_vector(openscop_vector_p vector)
{
  openscop_relation_p relation;

  if (vector == NULL)
    return NULL;

  relation = openscop_relation_malloc(1, vector->size);
  openscop_relation_replace_vector(relation, vector, 0);
  return relation;
}


/**
 * openscop_relation_replace_relation function:
 * this function replaces some rows of a relation "r1" with the rows of
 * the relation "r2". It begins at the "row"^th row of "r1". It directly
 * updates the relation union part pointed by "r1" and this part only.
 * \param[in,out] r1  The relation we want to change some rows.
 * \param[in]     r2  The relation containing the new rows.
 * \param[in]     row The first row of the relation r1 to be replaced.
 */
void
openscop_relation_replace_relation(openscop_relation_p r1,
                                   openscop_relation_p r2, int row)
{
  int i, j;

  if ((r1 == NULL) || (r2 == NULL) ||
      (r1->nb_columns != r1->nb_columns) ||
      ((row + r2->nb_rows) > r1->nb_rows) || (row < 0))
  {
    fprintf(stderr,"[OpenScop] Error: relation rows could not be replaced.\n");
    exit(1);
  }

  for (i = 0; i < r2->nb_rows; i++)
    for (j = 0; j < r2->nb_columns; j++)
      SCOPINT_assign(r1->m[i+row][j], r2->m[i][j]);
}


/**
 * openscop_relation_insert_relation function:
 * this function adds new rows corresponding to the relation "r1" to
 * the relation "r2" by inserting it at the "row"^th row. It directly
 * updates the relation union part pointed by "r1" and this part only.
 * If "r2" (or "r1") is NULL, the relation is left unmodified.
 * \param[in,out] r1  The relation we want to extend.
 * \param[in]     r2  The relation to be inserted.
 * \param[in]     row The row where to insert the relation
 */
void
openscop_relation_insert_relation(openscop_relation_p r1,
                                  openscop_relation_p r2, int row)
{
  int i, j;
  openscop_relation_p temp;

  if ((r1 == NULL) || (r2 == NULL))
    return;

  if ((r1->nb_columns != r2->nb_columns) ||
      (row > r1->nb_rows) || (row < 0))
  {
    fprintf(stderr,"[OpenScop] Error: constraints cannot be inserted.\n");
    exit(1);
  }

  // We use a temporary relation just to reuse existing functions. Cleaner.
  temp = openscop_relation_malloc(r1->nb_rows+r2->nb_rows, r1->nb_columns);

  for (i = 0; i < row; i++)
    for (j = 0; j < r1->nb_columns; j++)
      SCOPINT_assign(temp->m[i][j], r1->m[i][j]);

  openscop_relation_replace_relation(temp, r2, row);

  for (i = row + r2->nb_rows; i < r2->nb_rows + r1->nb_rows; i++)
    for (j = 0; j < r1->nb_columns; j++)
      SCOPINT_assign(temp->m[i][j], r1->m[i-r2->nb_rows][j]);

  openscop_relation_free_inside(r1);

  // Replace the inside of relation.
  r1->nb_rows = temp->nb_rows;
  r1->m = temp->m;

  // Free the temp "shell".
  free(temp);
}


/**
 * openscop_relation_concat function:
 * this function builds a new relation from two relations sent as
 * parameters. The new set of constraints is built as the concatenation
 * of the rows of the first elements of the two relation unions r1 and r2.
 * This means, there is no next field in the result.
 * \param[in] r1  The first relation.
 * \param[in] r2  The second relation.
 * \return A pointer to the relation resulting from the concatenation of
 *         the first elements of r1 and r2.
 */
openscop_relation_p
openscop_relation_concat(openscop_relation_p r1, openscop_relation_p r2)
{
  openscop_relation_p new;

  if (r1 == NULL)
    return openscop_relation_copy(r2);

  if (r2 == NULL)
    return openscop_relation_copy(r1);

  if (r1->nb_columns != r2->nb_columns)
  {
    fprintf(stderr, "[OpenScop] Error: incompatible sizes "
                    "for concatenation.\n");
    exit(1);
  }
  if (r1->next || r2->next)
  {
    fprintf(stderr, "[OpenScop] Warning: relation concatenation is done "
                    "on the first elements only.\n");
  }

  new = openscop_relation_malloc(r1->nb_rows+r2->nb_rows, r1->nb_columns);
  openscop_relation_replace_relation(new, r1, 0);
  openscop_relation_replace_relation(new, r2, r1->nb_rows);

  return new;
}


/**
 * openscop_relation_equal function:
 * this function returns true if the two relations provided as parameters
 * are the same, false otherwise.
 * \param[in] r1  The first relation.
 * \param[in] r2  The second relation.
 * \return 1 if r1 and r2 are the same (content-wise), 0 otherwise.
 */
int
openscop_relation_equal(openscop_relation_p r1, openscop_relation_p r2)
{
  int i, j;
  
  while ((r1 != NULL) && (r2 != NULL))
  {
    if (r1 == r2)
      return 1;

    if ((r1->nb_rows        != r2->nb_rows)        ||
        (r1->nb_columns     != r2->nb_columns)     ||
        (r1->nb_output_dims != r2->nb_output_dims) ||
        (r1->nb_input_dims  != r2->nb_input_dims)  ||
        (r1->nb_local_dims  != r2->nb_local_dims)  ||
        (r1->nb_parameters  != r2->nb_parameters))
      return 0;

    for (i = 0; i < r1->nb_rows; ++i)
      for (j = 0; j < r1->nb_columns; ++j)
        if (SCOPINT_ne(r1->m[i][j], r2->m[i][j]))
          return 0;

    r1 = r1->next;
    r2 = r2->next;
  }
  
  if (((r1 == NULL) && (r2 != NULL)) || ((r1 != NULL) && (r2 == NULL)))
    return 0;
  
  return 1;
}


/**
 * openscop_relation_check_property internal function:
 * This function checks whether an "actual" value is the same as an
 * "expected" value or not. If the expected value is set to
 * OPENSCOP_UNDEFINED, this function sets it to the "actual" value
 * and do not report a difference has been detected.
 * It returns 0 if a difference has been detected, 1 otherwise.
 * \param[in,out] expected Pointer to the expected value (the value is
 *                         modified if it was set to OPENSCOP_UNDEFINED).
 * \param[in]     actual   Value we want to check.
 * \return 0 if the values are not the same while the expected value was
 *         not OPENSCOP_UNDEFINED, 1 otherwise.
 */
static
int
openscop_relation_check_property(int * expected, int actual)
{
  if (*expected != OPENSCOP_UNDEFINED)
  { 
    if ((actual != OPENSCOP_UNDEFINED) &&
        (actual != *expected))
    {
      fprintf(stderr, "[OpenScop] Warning: unexpected property.\n");
      return 0;
    }
  }
  else
  {
    *expected = actual;
  }

  return 1;
}


/**
 * openscop_relation_check_nb_columns internal function:
 * This function checks that the number of columns of a relation
 * corresponds to some expected properties (setting an expected property to
 * OPENSCOP_UNDEFINED makes this function unable to detect a problem).
 * It returns 0 if the number of columns seems incorrect or 1 if no problem
 * has been detected.
 * \param[in] relation  The relation we want to check the number of columns.
 * \param[in] expected_nb_output_dims Expected number of output dimensions.
 * \param[in] expected_nb_input_dims  Expected number of input dimensions.
 * \param[in] expected_nb_parameters  Expected number of parameters.
 * \return 0 if the number of columns seems incorrect, 1 otherwise.
 */
static
int
openscop_relation_check_nb_columns(openscop_relation_p relation,
                                   int expected_nb_output_dims,
                                   int expected_nb_input_dims,
                                   int expected_nb_parameters)
{
  int expected_nb_local_dims, expected_nb_columns;
  
  if ((expected_nb_output_dims != OPENSCOP_UNDEFINED) &&
      (expected_nb_input_dims  != OPENSCOP_UNDEFINED) &&
      (expected_nb_parameters  != OPENSCOP_UNDEFINED))
  {
    if (relation->nb_local_dims == OPENSCOP_UNDEFINED)
      expected_nb_local_dims = 0;
    else
      expected_nb_local_dims = relation->nb_local_dims;

    expected_nb_columns = expected_nb_output_dims +
                          expected_nb_input_dims  +
                          expected_nb_local_dims  +
                          expected_nb_parameters  +
                          2;
    
    if (expected_nb_columns != relation->nb_columns)
    {
      fprintf(stderr, "[OpenScop] Warning: unexpected number of columns.\n");
      return 0;
    }
  }

  return 1;
}


/**
 * openscop_relation_consistency_check function:
 * this function checks that each part of an union of relations use the same
 * representation type (either matrix or relation representation). It returns
 * 1 if it is the case, 0 otherwise.
 * \param[in] r The relation to check for representation consistency.
 * \return 0 if the representation consistency check fails, 1 if it succeeds.
 */
static
int
openscop_relation_consistency_check(openscop_relation_p r)
{
  int matrix   = 0;
  int relation = 0;

  while (r != NULL)
  {
    if (r->nb_local_dims == OPENSCOP_UNDEFINED)
      matrix = 1;
    else
      relation = 1;

    r = r->next;
  }

  return (matrix == relation) ? 0 : 1;
}


/**
 * openscop_relation_integrity_check function:
 * this function checks that a relation is "well formed" according to some
 * expected properties (setting an expected value to OPENSCOP_UNDEFINED means
 * that we do not expect a specific value) and what the relation is supposed
 * to represent. It returns 0 if the check failed or 1 if no problem has been
 * detected.
 * \param[in] relation  The relation we want to check.
 * \param[in] type      Semantics about this relation (domain, access...).
 * \param[in] expected_nb_output_dims Expected number of output dimensions.
 * \param[in] expected_nb_input_dims  Expected number of input dimensions.
 * \param[in] expected_nb_parameters  Expected number of parameters.
 * \return 0 if the integrity check fails, 1 otherwise.
 */
int
openscop_relation_integrity_check(openscop_relation_p relation,
                                  int type,
                                  int expected_nb_output_dims,
                                  int expected_nb_input_dims,
                                  int expected_nb_parameters)
{
  int i, start;

  // Check the NULL case.
  if (relation == NULL)
  {
    if ((expected_nb_output_dims != OPENSCOP_UNDEFINED) &&
        (expected_nb_input_dims  != OPENSCOP_UNDEFINED) &&
        (expected_nb_parameters  != OPENSCOP_UNDEFINED))
    {
      fprintf(stderr, "[OpenScop] Warning: NULL relation with "
                      "some expected properties.\n");
      return 0;
    }
    else
    { 
      fprintf(stderr, "[OpenScop] Warning: NULL relation.\n");
      return 1;
    }
  }

  // Check the relation is using either matrix or relation representation.
  if (!openscop_relation_consistency_check(relation))
  {
    fprintf(stderr, "[OpenScop] Warning: inconsistent representation "
                    "(both matrix and relation).\n");
    return 0;
  }

  // Check that a context has actually 0 or an undefined #output dimensions.
  if ((type == OPENSCOP_TYPE_CONTEXT) &&
      ((relation->nb_output_dims != 0) &&
       (relation->nb_output_dims != OPENSCOP_UNDEFINED)))
  {
    fprintf(stderr, "[OpenScop] Warning: context without 0 "
                    "as number of output dimensions.\n");
    return 0;
  }

  // Check that a domain has actually 0 or an undefined #input dimensions.
  if (((type == OPENSCOP_TYPE_DOMAIN) ||
       (type == OPENSCOP_TYPE_CONTEXT)) &&
      ((relation->nb_input_dims != 0) &&
       (relation->nb_input_dims != OPENSCOP_UNDEFINED)))
  {
    fprintf(stderr, "[OpenScop] Warning: domain or context without 0 "
                    "as number of input dimensions.\n");
    return 0;
  }

  // Check properties according to expected values (and if expected values
  // are undefined, define them with the first relation part properties).
  if (!openscop_relation_check_property(&expected_nb_output_dims,
                                        relation->nb_output_dims) ||
      !openscop_relation_check_property(&expected_nb_input_dims,
                                        relation->nb_input_dims)  ||
      !openscop_relation_check_property(&expected_nb_parameters,
                                        relation->nb_parameters))
    return 0;

  while (relation != NULL)
  {
    // Properties (except the number of local dimensions) should be the same
    // in all parts.
    if ((expected_nb_output_dims != relation->nb_output_dims) ||
        (expected_nb_input_dims  != relation->nb_input_dims)  ||
        (expected_nb_parameters  != relation->nb_parameters))
    {
      fprintf(stderr, "[OpenScop] Warning: inconsistent properties.\n");
      return 0;
    }
   
    // Check whether the number of columns is OK or not.
    if (!openscop_relation_check_nb_columns(relation,
                                            expected_nb_output_dims,
                                            expected_nb_input_dims,
                                            expected_nb_parameters))
      return 0;

    // The first column of a relation part should be made of 0 or 1 only,
    // except:
    // - for the [0][0] element of an access function in "matrix"
    //   representation which should be > 0 (array identifier),
    //   and all other elements are 0.
    // - for scattering functions in "matrix" representation, the
    //   first column is made only of 0.
    if ((relation->nb_rows > 0) && (relation->nb_columns > 0))
    {
      start = 0;
      if ((relation->nb_local_dims == OPENSCOP_UNDEFINED) &&
          (type == OPENSCOP_TYPE_ACCESS))
      {
        start = 1;
        if (SCOPINT_get_si(relation->m[0][0]) <= 0)
        {
          fprintf(stderr, "[OpenScop] Warning: bad array identifier "
                          "in access function.\n");
          return 0;
        }
      }

      for (i = start; i < relation->nb_rows; i++)
      {
        if ((type == OPENSCOP_TYPE_ACCESS) &&
            (openscop_relation_is_matrix(relation)))
        {
          if (!SCOPINT_zero_p(relation->m[i][0]))
          {
            fprintf(stderr, "[OpenScop] Warning: non-first element of the "
                "first column of an access function is not 0.\n");
            return 0;
          }
        }
        else if ((type == OPENSCOP_TYPE_SCATTERING) &&
                 (openscop_relation_is_matrix(relation)))
        {
          if (!SCOPINT_zero_p(relation->m[i][0]))
          {
            fprintf(stderr, "[OpenScop] Warning: first column of a "
                            "scattering function not made of 0s.\n");
            return 0;
          }
        }
        else
        {
          if (!SCOPINT_zero_p(relation->m[i][0]) &&
              !SCOPINT_one_p(relation->m[i][0]))
          {
            fprintf(stderr, "[OpenScop] Warning: first column of a relation "
                            "is not made of 0 or 1 only.\n");
            return 0;
          }
        }
      }
    }

    // TODO: in relation format, array identifiers are
    //       m[i][#columns -1] / m[i][1], with i the only row
    //       where m[i][1] is not 0.
    //       - check there is exactly one row such that m[i][1] is not 0,
    //       - check that (m[i][#columns -1] % m[i][1]) == 0.

    relation = relation->next;
  }

  return 1;
}


/**
 * openscop_relation_union function:
 * this function builds a new relation from two relations provided
 * as parameters. The new relation is built as an union of the
 * two relations: the list of constraint sets are linked together.
 * \param[in] r1 The first relation.
 * \param[in] r2 The second relation.
 * \return A new relation corresponding to the union of r1 and r2.
 */
openscop_relation_p
openscop_relation_union(openscop_relation_p r1, openscop_relation_p r2)
{
  openscop_relation_p copy1, copy2, tmp;
  
  if ((r1 == NULL) && (r2 == NULL))
    return NULL;
  
  copy1 = openscop_relation_copy(r1);
  copy2 = openscop_relation_copy(r2);

  if ((r1 != NULL) && (r2 == NULL))
    return copy1;
    
  if ((r1 == NULL) && (r2 != NULL))
    return copy2;

  tmp = copy1;
  while (tmp->next != NULL)
    tmp = tmp->next;

  tmp->next = copy2;
  return copy1;
}