spot 2.3.4

- Main Page
- Related Pages
- Modules
- Classes
- Files

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Modules | Classes | Enumerations | Functions
Miscellaneous helper functions

## Modules
| Hashing functions
| Random functions

## Classes
struct | spot::bdd_less_than
| Comparison functor for BDDs. More...
struct | spot::bdd_hash
| Hash functor for BDDs. More...
struct | spot::char_ptr_less_than
| Strict Weak Ordering for `char*`. More...
class | spot::minato_isop
| Generate an irredundant sum-of-products (ISOP) form of a BDD function. More...
class | spot::option_map
| Manage a map of options. More...
struct | spot::stopwatch
| A simple stopwatch. More...
class | spot::temporary_file
| Temporary file name. More...
class | spot::trival
| A class implementing Kleene's three-valued logic. More...

## Enumerations
enum | { FirstStep, SecondStep, ThirdStep, FourthStep }
enum | value_t : repr_t { no_value = -1, maybe_value = 0, yes_value = 1 }

## Functions
const char * | spot::version ()
| Return Spot's version. More...
bool | spot::is_bare_word (const char *str)
| Whether a word is bare. More...
std::string | spot::quote_unless_bare_word (const std::string &str)
| Double-quote words that are not bare. More...
bool | spot::is_spin_ap (const char *str)
| Whether a word can be used as an atomic proposition for Spin 5. More...
std::ostream & | spot::escape_rfc4180 (std::ostream &os, const std::string &str)
| Double characters `"` in strings. More...
std::ostream & | spot::escape_latex (std::ostream &os, const std::string &str)
| Escape special LaTeX characters. More...
std::ostream & | spot::escape_html (std::ostream &os, const std::string &str)
| Escape special HTML characters. More...
std::ostream & | spot::escape_str (std::ostream &os, const std::string &str)
| Escape characters `"`, `\`, and `\n` in str. More...
std::string | spot::escape_str (const std::string &str)
| Escape characters `"`, `\`, and `\n` in str. More...
std::ostream & | spot::quote_shell_string (std::ostream &os, const char *str)
| Output str between simple quote or double quotes. More...
void | spot::int_array_array_compress2 (const int *array, size_t n, int *dest, size_t &dest_size)
| Compress an int array of size n into a int array. More...
void | spot::int_array_array_decompress2 (const int *array, size_t array_size, int *res, size_t size)
| Uncompress an int array of size array_size into a int array of size size. More...
void | spot::int_vector_vector_compress (const std::vector< int > &input, std::vector< unsigned int > &output)
| Compress an int vector into a vector of unsigned int. More...
void | spot::int_vector_vector_decompress (const std::vector< unsigned int > &array, std::vector< int > &output, size_t size)
| Uncompress a vector of unsigned int into a vector of size size. More...
const std::vector< unsigned int > * | spot::int_array_vector_compress (const int *array, size_t n)
| Compress an int array if size n into a vector of unsigned int. More...
void | spot::int_vector_array_decompress (const std::vector< unsigned int > *array, int *res, size_t size)
| Uncompress a vector of unsigned int into an int array of size size. More...
void | spot::int_array_array_compress (const int *array, size_t n, int *dest, size_t &dest_size)
| Compress an int array of size n into a int array. More...
void | spot::int_array_array_decompress (const int *array, size_t array_size, int *res, size_t size)
| Uncompress an int array of size array_size into a int array of size size. More...

## Detailed Description

## Function Documentation

std::ostream& spot::escape_html | ( | std::ostream & | os,
|  | const std::string & | str
| ) |  |

`#include <spot/misc/escape.hh>`

Escape special HTML characters.

The following characters are rewritten: `> < " &`

std::ostream& spot::escape_latex | ( | std::ostream & | os,
|  | const std::string & | str
| ) |  |

`#include <spot/misc/escape.hh>`

Escape special LaTeX characters.

The following characters are rewritten: `& % $ # _ { } ~ ^ \`

std::ostream& spot::escape_rfc4180 | ( | std::ostream & | os,
|  | const std::string & | str
| ) |  |

`#include <spot/misc/escape.hh>`

Double characters `"` in strings.

In CSV files, as defined by RFC4180, double-quoted string that contain double-quotes should simply duplicate those quotes.

std::ostream& spot::escape_str | ( | std::ostream & | os,
|  | const std::string & | str
| ) |  |

`#include <spot/misc/escape.hh>`

Escape characters `"`, `\`, and `\n` in str.

std::string spot::escape_str | ( | const std::string & | str | ) |

`#include <spot/misc/escape.hh>`

Escape characters `"`, `\`, and `\n` in str.

void spot::int_array_array_compress | ( | const int * | array,
|  | size_t | n,
|  | int * | dest,
|  | size_t & | dest_size
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Compress an int array of size n into a int array.

The destination array should be at least dest_size large An assert will be triggered if dest_size is too small. On return, dest_size will be set to the actually number of int filled in dest

void spot::int_array_array_compress2 | ( | const int * | array,
|  | size_t | n,
|  | int * | dest,
|  | size_t & | dest_size
| ) |  |

`#include <spot/misc/intvcmp2.hh>`

Compress an int array of size n into a int array.

The destination array should be at least dest_size large An assert will be triggered if dest_size is too small. On return, dest_size will be set to the actually number of int filled in dest

void spot::int_array_array_decompress | ( | const int * | array,
|  | size_t | array_size,
|  | int * | res,
|  | size_t | size
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Uncompress an int array of size array_size into a int array of size size.

size must be the exact expected size of uncompressed array.

void spot::int_array_array_decompress2 | ( | const int * | array,
|  | size_t | array_size,
|  | int * | res,
|  | size_t | size
| ) |  |

`#include <spot/misc/intvcmp2.hh>`

Uncompress an int array of size array_size into a int array of size size.

size must be the exact expected size of uncompressed array.

const std::vector<unsigned int>* spot::int_array_vector_compress | ( | const int * | array,
|  | size_t | n
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Compress an int array if size n into a vector of unsigned int.

void spot::int_vector_array_decompress | ( | const std::vector< unsigned int > * | array,
|  | int * | res,
|  | size_t | size
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Uncompress a vector of unsigned int into an int array of size size.

size must be the exact expected size of uncompressed array.

void spot::int_vector_vector_compress | ( | const std::vector< int > & | input,
|  | std::vector< unsigned int > & | output
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Compress an int vector into a vector of unsigned int.

void spot::int_vector_vector_decompress | ( | const std::vector< unsigned int > & | array,
|  | std::vector< int > & | output,
|  | size_t | size
| ) |  |

`#include <spot/misc/intvcomp.hh>`

Uncompress a vector of unsigned int into a vector of size size.

size must be the exact expected size of uncompressed array.

bool spot::is_bare_word | ( | const char * | str | ) |

`#include <spot/misc/bareword.hh>`

Whether a word is bare.

Bare words should start with a letter, an underscore, or a dot, and consist solely of alphanumeric characters, underscores, and dots.

bool spot::is_spin_ap | ( | const char * | str | ) |

`#include <spot/misc/bareword.hh>`

Whether a word can be used as an atomic proposition for Spin 5.

In Spin 5 (hence in ltl2ba and ltl3ba as well) atomic propositions should start with a lowercase letter, and can then consist solely of alphanumeric characters and underscores.

std::ostream& spot::quote_shell_string | ( | std::ostream & | os,
|  | const char * | str
| ) |  |

`#include <spot/misc/escape.hh>`

Output str between simple quote or double quotes.

Simple quotes are preferred unless str contains some simple quotes. In that case we use double quotes and escape anything that needs to be escaped.

std::string spot::quote_unless_bare_word | ( | const std::string & | str | ) |

`#include <spot/misc/bareword.hh>`

Double-quote words that are not bare.

See also
  is_bare_word

const char* spot::version | ( |  | ) |

`#include <spot/misc/version.hh>`

Return Spot's version.

Please direct any question, comment, or bug report to the Spot mailing list at spot@lrde.epita.fr.