/* interfaceIntIndex.h
 * Copyright (C) 2011, Antonio Fariña, all rights reserved.
 *
 * interfaceIntIndex.h: Interface for an int-based self-index.
 *   Including functions to build, search(count/locate/display), save, load, size,...
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

// FUNCTION PROTOTYPES: SELF-INDEX ON INTEGERS.

int buildIntIndex (uint *intVector, uint n, char *build_options, void **index );
		
	//Saves the index to disk
int saveIntIndex(void *index, char *pathname);

	//Returns number of elements in the indexed sequence of integers
int sourceLenIntIndex(void *index, uint *numInts);

	//Loads the index from disk.
int loadIntIndex(char *pathname, void **index);
	
	//Frees the memory allocated to the int_index
int freeIntIndex(void *index);

	//Returns the size (in bytes) of the index over the sequence of integers.
int sizeIntIndex(void *index, uint *numBytes);

	// Shows detailed summary info of the self-index (memory usage of each structure)
int printInfoIntIndex(void *index, const char tab[]);
	
	//Number of occurrences of the pattern, and the interval [left,right] in the suffix array
int countIntIndex(void *index, uint *pattern, uint length, ulong *numocc, ulong *left, ulong *right);
	
	//returns an array with integers corresponding offsets to the occurrences of the pattern, 
	//as well as the number of occurrences
int locateIntIndex(void *index, uint *pattern, uint length, ulong **occ, ulong *numocc);
	
	//Returns the value of the source (array of integers) at a given offset.
	// (that is, the element "position" from the original array of uints)
int displayIntIndex(void *index, ulong position, uint *value);