prt_tuple.h File Reference

PRT tuple. More...

#include "prt.h"

Include dependency graph for prt_tuple.h:

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

Go to the source code of this file.

Macros
#define	prt_tuple_new1(a)   prt_tuple_new(1,a)
#define	prt_tuple_new2(a, b)   prt_tuple_new(2,a,b)
#define	prt_tuple_new3(a, b, c)   prt_tuple_new(3,a,b,c)
#define	prt_tuple_new4(a, b, c, d)   prt_tuple_new(4,a,b,c,d)
#define	prt_tuple_new5(a, b, c, d, e)   prt_tuple_new(5,a,b,c,d,e)
#define	prt_tuple_new6(a, b, c, d, e, f)   prt_tuple_new(6,a,b,c,d,e,f)

Functions
int *	prt_tuple_new (int len,...)
	tuple constructor Allocates memory for the tuple plus the termination symbol (INT_MAX). More...
int	prt_tuple_len (int *tuple)
	tuple length More...
int *	prt_tuple_cat (int *first_tuple,...)
	tuple concatenate Join a variable length, NULL-terminated, list of tuples. More...
void	prt_tuple_delete (int *tuple)
	tuple destructor More...
int *	prt_tuple_copy (int *in_tuple)
	tuple copy constructor More...
int	prt_tuple_compare (void *tuple_a, void *tuple_b)
	tuple comparison More...
int	prt_tuple_equal (void *tuple_a, void *tuple_b)
	tuple equality check Check if tuples are identical in length and content. More...
void	prt_tuple_print (int *tuple)
	tuple print More...
unsigned int	prt_tuple_hash (void *tuple)
	tuple hash Required by the VSA's tuples hash table. Computes the lenght in characters and calls a string hash function. More...

Detailed Description

PRT tuple.

Author

Jakub Kurzak

Tuples uniquely identify VDPs in a VSA. Tuple is an array of integers terminated with INT_MAX. For all practical purposes a tuple behaves like a string.

PULSAR Runtime /pulsar/ Copyright (C) 2012-2013 University of Tennessee.

Definition in file prt_tuple.h.

Macro Definition Documentation

#define prt_tuple_new1

(

a

)

prt_tuple_new(1,a)

Definition at line 34 of file prt_tuple.h.

#define prt_tuple_new2	(		a,
			b
	)		prt_tuple_new(2,a,b)

Definition at line 35 of file prt_tuple.h.

#define prt_tuple_new3	(		a,
			b,
			c
	)		prt_tuple_new(3,a,b,c)

Definition at line 36 of file prt_tuple.h.

#define prt_tuple_new4	(		a,
			b,
			c,
			d
	)		prt_tuple_new(4,a,b,c,d)

Definition at line 37 of file prt_tuple.h.

#define prt_tuple_new5	(		a,
			b,
			c,
			d,
			e
	)		prt_tuple_new(5,a,b,c,d,e)

Definition at line 38 of file prt_tuple.h.

#define prt_tuple_new6	(		a,
			b,
			c,
			d,
			e,
			f
	)		prt_tuple_new(6,a,b,c,d,e,f)

Definition at line 39 of file prt_tuple.h.

Function Documentation

int* prt_tuple_cat	(	int *	first_tuple,
			...
	)

tuple concatenate Join a variable length, NULL-terminated, list of tuples.

Parameters

first_tuple
...	the other tuples

Returns

the combined tuple

Definition at line 64 of file prt_tuple.c.

References prt_assert, and prt_tuple_len().

{
    int len;
    int *tuple;
    va_list ap;
    va_start(ap, first_tuple);
    len = prt_tuple_len(first_tuple);
    while ((tuple = va_arg(ap, int*)) != NULL)
        len += prt_tuple_len(tuple);
    va_end(ap);

    int *out_tuple = (int*)malloc((len+1)*sizeof(int));
    prt_assert(out_tuple != NULL, "malloc failed");
    va_start(ap, first_tuple);
    while(*first_tuple != INT_MAX)
        *out_tuple++ = *first_tuple++;
    while ((tuple = va_arg(ap, int*)) != NULL)
        while(*tuple != INT_MAX)
            *out_tuple++ = *tuple++;
    va_end(ap);

    *out_tuple = INT_MAX;
    return (out_tuple-len);
}

Here is the call graph for this function:

int prt_tuple_compare	(	void *	tuple_a,
		void *	tuple_b
	)

tuple comparison

Parameters

tuple_a
tuple_b

Return values

-1	tuple_a is less than tuple_b.
0	tuple_a is equal to tuple_b.
1	tuple_a is greater than tuple_b.

Definition at line 135 of file prt_tuple.c.

{
    int *tupa = (int*)tuple_a;
    int *tupb = (int*)tuple_b;
    while (*tupa != INT_MAX && *tupb != INT_MAX) {
        if (*tupa < *tupb) return -1;
        else if (*tupa > *tupb) return 1;
        tupa++;
        tupb++;
    }
    if (*tupa == INT_MAX && *tupb == INT_MAX) return 0;
    else if (*tupa == INT_MAX) return -1;
    else if (*tupb == INT_MAX) return 1;
}

Here is the caller graph for this function:

int* prt_tuple_copy

(

int *

in_tuple

)

tuple copy constructor

Parameters

in_tuple

Returns

new copy

Definition at line 109 of file prt_tuple.c.

References prt_assert.

{
    int i;
    int len = 0;
    int *out_tuple;
    while (in_tuple[len] != INT_MAX)
        len++;
    out_tuple = (int*)malloc((len+1)*sizeof(int));
    prt_assert(out_tuple != NULL, "malloc failed");
    for (i = 0; i < len; i++)
        out_tuple[i] = in_tuple[i];
    out_tuple[len] = INT_MAX;
    return out_tuple;
}

void prt_tuple_delete

(

int *

tuple

)

tuple destructor

Parameters

tuple

Definition at line 95 of file prt_tuple.c.

{
    // Free the tuple.
    free(tuple);
}

Here is the caller graph for this function:

int prt_tuple_equal	(	void *	tuple_a,
		void *	tuple_b
	)

tuple equality check Check if tuples are identical in length and content.

Parameters

tuple_a
tuple_b

Return values

0	Tuples differ.
1	Tuples are identical.

Definition at line 161 of file prt_tuple.c.

{
    return (prt_tuple_compare(tuple_a, tuple_b) == 0);
}

unsigned int prt_tuple_hash

(

void *

tuple

)

tuple hash Required by the VSA's tuples hash table. Computes the lenght in characters and calls a string hash function.

Parameters

tuple

Returns

hash

Definition at line 188 of file prt_tuple.c.

{
    int len = 0;
    int *tup = (int*)tuple;
    while (tup[len] != INT_MAX)
        len++;
    return fnv_hash(tuple, len*sizeof(int));
}

int prt_tuple_len

(

int *

tuple

)

tuple length

Parameters

tuple

Returns

tuple length without the terminating symbol

Definition at line 47 of file prt_tuple.c.

{
    int *p = tuple;
    while (*p++ != INT_MAX);
    return (p-tuple-1);
}

Here is the caller graph for this function:

int* prt_tuple_new	(	int	len,
			...
	)

tuple constructor Allocates memory for the tuple plus the termination symbol (INT_MAX).

Parameters

len	length of the tuple
...	list of elements of type int

Returns

pointer to an integer array terminated with INT_MAX

Definition at line 25 of file prt_tuple.c.

References prt_assert.

{
    int *tuple = (int*)malloc((len+1)*sizeof(int));
    prt_assert(tuple != NULL, "malloc failed");
    int i;
    va_list ap;
    va_start(ap, len);
    for (i = 0; i < len; i++)
        tuple[i] = va_arg(ap, int);
    va_end(ap);
    tuple[len] = INT_MAX;
    return tuple;
}

void prt_tuple_print

(

int *

tuple

)

tuple print

Parameters

tuple

Definition at line 172 of file prt_tuple.c.

{
    while (*tuple != INT_MAX)
        printf("%3d", *tuple++);
}

Here is the caller graph for this function: