# Overview

This section explains how to compile and link your code with the Yices library.

The Yices API is defined in three header files:

• yices.h declares all functions and constants

• yices_types.h defines the types and data structures used in the API

• yices_limits.h defines hard-coded limits

For a standard installation, these files are in directory /usr/local/include.

To use the API, you should add the following line to your code:

#include <yices.h>


and link with the Yices library using option -lyices.

Several functions in the API take GMP numbers (e.g., mpq_t or mpz_t) as arguments. To use these functions, make sure to include the GMP header before you include yices.h as in:

#include <gmp.h>
#include <yices.h>


Similarly, some functions return algebraic numbers and use data structures defined in the libpoly library. To use these functions, you must include the libpoly header poly/algebraic_number.h before yices.h:

#include <poly/algebraic_number.h>
#include <yices.h>


Note

Yices requires the C99 header stdint.h. This header may not be available on old versions of Microsoft’s Visual Studio. If it is missing, open-source versions of stdint.h can be downloaded at

A copy of the latter file is included in the Yices distributions (in etc/pstdint.h).

## Minimal Example

Here is a minimal example:

#include <stdio.h>
#include <yices.h>

int main(void) {
printf("Testing Yices %s (%s, %s)\n", yices_version,
yices_build_arch, yices_build_mode);
return 0;
}


Assuming that Yices is installed in the standard location, this example should compile with:

gcc minimal.c -o minimal -lyices


Other compilers than GCC can be used. If Yices is installed in a different location, give appropriate flags to the compilation command. For example:

gcc -I${HOME}/yices-2.3.1/include -L${HOME}/yices-2.3.1/lib \
minimal.c -o minimal -lyices


Running the program should print something like this:

Testing Yices 2.3.1 (x86_64-unknown-linux-gnu, release)


You may need to play with environment variable LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on Mac OS X) if the runtime Yices library is not found.