CITree.h

Go to the documentation of this file.

/*
 * Copyright 2015 Brendan Bruner
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * bbruner@ualberta.ca
 * July 12, 2016
 */
#ifndef UTIL_CITREE_H_
#define UTIL_CITREE_H_

#include <Class.h>

/************************************************************************/
/* Error codes.                             */
/************************************************************************/
typedef enum
{
    CITREE_OK = 0,
    CITREE_ERR_EMPTY = 1,
    CITREE_ERR_FULL = 2,
    CITREE_ERR_EXT = 3
} CITreeError;


/************************************************************************/
/* Declare interface and vtable.                    */
/************************************************************************/
struct CITree
{
    /* CInterface must always be first member of */
    /* an interfaces struct .*/
    struct CInterface interface;
};

struct CITree_VTable
{
    CITreeError (*push)( struct CITree*, const void*, const void* );
    CITreeError (*pop)( struct CITree*, void* );
    CITreeError (*peek)( struct CITree*, void* );
    CITreeError (*get)( struct CITree*, void*, size_t );
    CITreeError (*delete)( struct CITree*, void*, size_t );
    CITreeError (*delete_element)( struct CITree*, void* );
    size_t (*size)( struct CITree* );
    size_t (*max_size)( struct CITree* );
    void (*clear)( struct CITree* );

    /* Reserved for future expansion.
     */
    CITreeError (*split)( struct CITree*, void* );

    /* Reserved for future expansion.
     */
    CITreeError (*merge)( struct CITree*, struct CITree* );
};


/************************************************************************/
/* Class methods.                           */
/************************************************************************/
CITreeError CITree_Push( struct CITree* self, const void* element, const void* key );

CITreeError CITree_Pop( struct CITree* self, void* element );

CITreeError CITree_DeleteElement( struct CITree* self, void* element );

CITreeError CITree_Peek( struct CITree* self, void* element );

CITreeError CITree_Get( struct CITree* self, void* element, size_t index );

CITreeError CITree_Delete( struct CITree* self, void* element, size_t index );

size_t CITree_Size( struct CITree* self );

size_t CITree_MaxSize( struct CITree* self );

void CITree_Clear( struct CITree* self );

#endif /* UTIL_CITREE_H_ */