Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 2.96 KB

cstack_api.md

File metadata and controls

80 lines (58 loc) · 2.96 KB
Raw

STC cstack: Stack

Stack

The cstack is a container adapter that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The stack pushes and pops the element from the back of the underlying container, known as the top of the stack.

See the c++ class std::stack for a functional description.

Header file and declaration

#include <stc/cstack.h> /* includes default underlying implementation header cvec.h */

using_cstack(X, ctype)

The macro using_cstack() must be instantiated in the global scope. cstack uses normally a cvec_X or cdeq_X type as underlying implementation, given as ctype. X is a type tag name and will affect the names of all cstack types and methods. E.g. declaring using_cstack(i, cvec_i);, X should be replaced by i in all of the following documentation.

Methods

cstack_X                cstack_X_init(void);
cstack_X                cstack_X_clone(cstack_X st);

void                    cstack_X_clear(cstack_X* self);
void                    cstack_X_del(cstack_X* self);      // destructor

size_t                  cstack_X_size(cstack_X st);
bool                    cstack_X_empty(cstack_X st);
cstack_X_value_t*       cstack_X_top(const cstack_X* self);

void                    cstack_X_push(cstack_X* self, cstack_X_value_t value);
void                    cstack_X_emplace(cstack_X* self, cstack_X_rawvalue_t raw);
void                    cstack_X_emplace_n(cstack_X *self, const cstack_X_rawvalue_t arr[], size_t n);

void                    cstack_X_pop(cstack_X* self);

cstack_X_iter_t         cstack_X_begin(const cstack_X* self);
cstack_X_iter_t         cstack_X_end(const cstack_X* self);
void                    cstack_X_next(cstack_X_iter_t* it);

cstack_X_value_t        cstack_X_value_clone(cstack_X_value_t val);

Types

Type name Type definition Used to represent...
cstack_X Depends on underlying container type The cstack type
cstack_X_value_t " The cstack element type
cstack_X_rawvalue_t " cstack raw value type
cstack_X_iter_t " cstack iterator

Example

#include <stc/cstack.h>
#include <stdio.h>

using_cvec(i, int);
using_cstack(i, cvec_i);

int main() {
    cstack_i S = cstack_i_init();

    for (int i=0; i < 100; ++i)
        cstack_i_push(&S, i*i);

    for (int i=0; i < 90; ++i)
        cstack_i_pop(&S);

    printf("top: %d\n", *cstack_i_top(&S));

    cstack_i_del(&S);
}

Output:

top: 81