vector.c File Reference

This is a vector implemenation in C. More...

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

Include dependency graph for vector.c:

Data Structures
struct	Vector
	for IO operations More...

Functions
void	init (Vector *vec, int val)
	This function initilaizes the vector and gives it a size of 1 and initializes the first index to 0. More...
void	delete (Vector *vec)
	This function clears the heap memory allocated by the Vector. More...
void	clear (Vector *vec)
	This function clears the contents of the Vector. More...
int	len (Vector *vec)
	This function returns the length the Vector. More...
void	push (Vector *vec, int val)
	This function pushes a value to the end of the Vector. More...
int	get (Vector *vec, int index)
	This function get the item at the specified index of the Vector. More...
void	set (Vector *vec, int index, int val)
	This function sets an item at the specified index of the Vector. More...
int	next (Vector *vec)
	This function gets the next item from the Vector each time it's called. More...
void *	begin (Vector *vec)
	This function returns the pointer to the begining of the Vector. More...
void	print (Vector *vec)
	This function prints the entire Vector as a list. More...
static void	test ()
	This function tests the functions used to work with Vectors. More...
int	main ()
	Main function. More...

Detailed Description

This is a vector implemenation in C.

A vector is an expandable array.

This vector implementation in C comes with some wrapper functions that lets the user work with data without having to worrying about memory.

Function Documentation

begin()

void * begin

(

Vector *

vec

)

This function returns the pointer to the begining of the Vector.

@params Vector* (a pointer to the Vector struct)

Returns

: void*

                         {
    return (void*)vec->contents;
}

clear()

void clear

(

Vector *

vec

)

This function clears the contents of the Vector.

@params Vector* (a pointer to the Vector struct)

Returns

: none

                        {
    delete(vec);
    init(vec, 0);
}

Here is the call graph for this function:

delete()

void delete

(

Vector *

vec

)

This function clears the heap memory allocated by the Vector.

@params Vector* (a pointer to the Vector struct)

Returns

: none

                         {
    free(vec->contents);    
}

get()

int get	(	Vector *	vec,
		int	index
	)

This function get the item at the specified index of the Vector.

@params Vector* (a pointer to the Vector struct) @params int (the index to get value from)

Returns

: int

                                {
    if(index < vec->len) {
        return vec->contents[index];
    }
    return -1;
}

init()

void init	(	Vector *	vec,
		int	val
	)

This function initilaizes the vector and gives it a size of 1 and initializes the first index to 0.

@params Vector* (a pointer to the Vector struct) @params int (the actual data to be passed to the vector)

Returns

none

                                {
    vec->contents = (int*)malloc(sizeof(int));
    vec->contents[0] = val;
    vec->current = 0;
    vec->len = 1;
}

len()

int len

(

Vector *

vec

)

This function returns the length the Vector.

@params Vector* (a pointer to the Vector struct)

Returns

: int

                     {
    return vec->len;    
}

main()

int main

(

void

)

Main function.

Returns

0 on exit

           {
    test();
 
    Vector vec;
    init(&vec, 10);
    push(&vec, 20);
    print(&vec);
    set(&vec, 0, 11);
    set(&vec, 1, 22);
    print(&vec);
    printf("Length: %d\n", len(&vec));
    return 0;
}

Here is the call graph for this function:

next()

int next

(

Vector *

vec

)

This function gets the next item from the Vector each time it's called.

@params Vector* (a pointer to the Vector struct)

Returns

: int

                      {
    if(vec->current == vec->len) {
        vec->current = 0;
    }
    int current_val = vec->contents[vec->current];
    vec->current++;
    return current_val;
}

print()

void print

(

Vector *

vec

)

This function prints the entire Vector as a list.

@params Vector* (a pointer to the Vector struct)

Returns

: none

                        {
    int size = vec->len;
    printf("[ ");
    for(int count = 0; count < size; count++) {
        printf("%d ", vec->contents[count]);
    }
    printf("]\n");
}

push()

void push	(	Vector *	vec,
		int	val
	)

This function pushes a value to the end of the Vector.

@params Vector* (a pointer to the Vector struct) @params int (the value to be pushed)

Returns

: none

                                {
    vec->contents = realloc(vec->contents, (sizeof(int) * (vec->len + 1)));
    vec->contents[vec->len] = val;
    vec->len++;
}

Here is the call graph for this function:

set()

void set	(	Vector *	vec,
		int	index,
		int	val
	)

This function sets an item at the specified index of the Vector.

@params Vector* (a pointer to the Vector struct) @params int (the index to set value at)

Returns

: none

                                          {
    if(index < vec->len) {
        vec->contents[index] = val;
    }
}

test()

static void test ( void  )

static

This function tests the functions used to work with Vectors.

Returns

: none

                   {
    Vector vec;
    init(&vec, 10);
    assert(get(&vec, 0) == 10);
    push(&vec, 20);
    assert(get(&vec, 1) == 20);
    set(&vec, 0, 11);
    assert(get(&vec, 0) == 11);
    assert(next(&vec) == 11);
    set(&vec, 1, 22);
    assert(get(&vec, 1) == 22);
    assert(len(&vec) == 2);
}

Here is the call graph for this function: