tuple.h

Go to the documentation of this file.

/*
 * Copyright 2003, 2004 Ian Searle. All rights reserved.
 *
 * 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. 
 *
 * THIS SOFTWARE IS PROVIDED ``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 IAN SEARLE OR CONTRIBUTORS
 * 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. 
 *
 */

#ifndef _TUPLE_H
#define _TUPLE_H

#include "segment.h"

typedef struct _tuple Tuple;

struct _tuple {
  Segment *seg;          
  unsigned int ibegin;   
  unsigned int iend;     
};


void tuple_Init(void *(*tuple_allocate)(size_t), void (*tuple_deallocate)(void *));

Tuple *tuple_Create(Segment *seg, unsigned int ibegin, unsigned int iend);

void tuple_DeleteBorrowed(Tuple *tuple);

void tuple_DeleteOwned(Tuple *tuple);

Tuple *tuple_Copy(Tuple *tuple);

void tuple_Print(Tuple *tuple);

char *tuple_SegElPtr(Tuple *tuple, unsigned int index);

Segment *tuple_Seg(Tuple *tuple);

unsigned int tuple_Begin(Tuple *tuple);

unsigned int tuple_End(Tuple *tuple);

/*
 * \brief
 *   Set the begin index of a tuple.
 *
 * \param tuple The input tuple to manipulate.
 * \param end The new begin value to set.
 *
 * \return 0 success
 * \return 1 failure: tuple pointer invalid value (null)
 * \return 2 failure: begin > tuple_End(tuple)
 */
unsigned int tuple_SetBegin(Tuple *tuple, unsigned int begin);

/*
 * \brief
 *   Set the end index of a tuple.
 *
 * \param tuple The input tuple to manipulate.
 * \param end The new end value to set.
 *
 * \return 0 success
 * \return 1 failure: tuple pointer invalid value (null)
 * \return 2 failure: end >= tuple_Length()
 * \return 3 failure: end < tuple_Begin(tuple)
 */
unsigned int tuple_SetEnd(Tuple *tuple, unsigned int end);

unsigned int tuple_Length(Tuple *tuple);

unsigned int tuple_ShiftBegin(Tuple *tuple, unsigned int N);

unsigned int tuple_ShiftEnd(Tuple *tuple, unsigned int N);

#endif  /* _TUPLE_H */

---