A type for closed integer intervals [from, to]. More...

#include <mathematical_types.h>

Inheritance diagram for integer_range_typet:

Collaboration diagram for integer_range_typet:

Public Member Functions
	integer_range_typet (const mp_integer &_from, const mp_integer &_to)

mp_integer	from () const

mp_integer	to () const

bool	includes (const mp_integer &) const

constant_exprt	zero_expr () const

constant_exprt	one_expr () const

mp_integer	size () const

bool	empty () const

void	from (const mp_integer &)

void	to (const mp_integer &)

Public Member Functions inherited from typet
	typet ()

	typet (const irep_idt &_id)

	typet (irep_idt _id, typet _subtype)

typet &	add_subtype ()

bool	has_subtypes () const

bool	has_subtype () const

void	remove_subtype ()

const source_locationt &	source_location () const

source_locationt &	add_source_location ()

typet &&	with_source_location (source_locationt location) &&
	This is a 'fluent style' method for creating a new type with an added-on source location.

typet &	with_source_location (source_locationt location) &
	This is a 'fluent style' method for adding a source location.

typet &&	with_source_location (const typet &type) &&
	This is a 'fluent style' method for creating a new type with an added-on source location.

typet &	with_source_location (const typet &type) &
	This is a 'fluent style' method for adding a source location.

typet &	add_type (const irep_idt &name)

const typet &	find_type (const irep_idt &name) const

Public Member Functions inherited from irept
bool	is_nil () const

bool	is_not_nil () const

	irept (const irep_idt &_id)

	irept (const irep_idt &_id, const named_subt &_named_sub, const subt &_sub)

	irept ()=default

const irep_idt &	id () const

const std::string &	id_string () const

void	id (const irep_idt &_data)

const irept &	find (const irep_idt &name) const

irept &	add (const irep_idt &name)

irept &	add (const irep_idt &name, irept irep)

const std::string &	get_string (const irep_idt &name) const

const irep_idt &	get (const irep_idt &name) const

bool	get_bool (const irep_idt &name) const

signed int	get_int (const irep_idt &name) const

std::size_t	get_size_t (const irep_idt &name) const

long long	get_long_long (const irep_idt &name) const

void	set (const irep_idt &name, const irep_idt &value)

void	set (const irep_idt &name, irept irep)

void	set (const irep_idt &name, const long long value)

void	set_size_t (const irep_idt &name, const std::size_t value)

void	remove (const irep_idt &name)

void	move_to_sub (irept &irep)

void	move_to_named_sub (const irep_idt &name, irept &irep)

bool	operator== (const irept &other) const

bool	operator!= (const irept &other) const

void	swap (irept &irep)

bool	operator< (const irept &other) const
	defines ordering on the internal representation

bool	ordering (const irept &other) const
	defines ordering on the internal representation

int	compare (const irept &i) const
	defines ordering on the internal representation comments are ignored

void	clear ()

void	make_nil ()

subt &	get_sub ()

const subt &	get_sub () const

named_subt &	get_named_sub ()

const named_subt &	get_named_sub () const

std::size_t	hash () const

std::size_t	full_hash () const

bool	full_eq (const irept &other) const

std::string	pretty (unsigned indent=0, unsigned max_indent=0) const

Public Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
	sharing_treet (irep_idt _id)

	sharing_treet (irep_idt _id, named_subt _named_sub, subt _sub)

	sharing_treet ()

	sharing_treet (const sharing_treet &irep)

	sharing_treet (sharing_treet &&irep)

sharing_treet &	operator= (const sharing_treet &irep)

sharing_treet &	operator= (sharing_treet &&irep)

	~sharing_treet ()

const dt &	read () const

dt &	write ()

Additional Inherited Members
Public Types inherited from irept
using	baset = tree_implementationt

Public Types inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
using	dt = tree_nodet< irept, forward_list_as_mapt< irep_idt, irept >, true >

using	subt = typename dt::subt

using	named_subt = typename dt::named_subt

using	tree_implementationt = sharing_treet
	Used to refer to this class from derived classes.

Static Public Member Functions inherited from typet
static void	check (const typet &, const validation_modet=validation_modet::INVARIANT)
	Check that the type is well-formed (shallow checks only, i.e., subtypes are not checked)

static void	validate (const typet &type, const namespacet &, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed, assuming that its subtypes have already been checked for well-formedness.

static void	validate_full (const typet &type, const namespacet &ns, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed (full check, including checks of subtypes)

Static Public Member Functions inherited from irept
static bool	is_comment (const irep_idt &name)

static std::size_t	number_of_non_comments (const named_subt &)
	count the number of named_sub elements that are not comments

Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
void	detach ()

Static Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static void	remove_ref (dt *old_data)

static void	nonrecursive_destructor (dt *old_data)
	Does the same as remove_ref, but using an explicit stack instead of recursion.

Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
dt *	data

Static Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static dt	empty_d

Detailed Description

A type for closed integer intervals [from, to].

Both endpoints are inclusive. The interval may be empty (if from > to).

Definition at line 149 of file mathematical_types.h.

Constructor & Destructor Documentation

◆ integer_range_typet()

integer_range_typet::integer_range_typet	(	const mp_integer &	_from,
		const mp_integer &	_to
	)

inline

Definition at line 152 of file mathematical_types.h.

Member Function Documentation

◆ empty()

bool integer_range_typet::empty ( ) const

Returns: True iff the range contains no elements, i.e. from() > to() (equivalently, size() == 0).

Definition at line 110 of file mathematical_types.cpp.

◆ from() [1/2]

mp_integer integer_range_typet::from ( ) const

Returns: The lower bound of the interval (inclusive).

Definition at line 94 of file mathematical_types.cpp.

◆ from() [2/2]

void integer_range_typet::from ( const mp_integer & from )

Definition at line 84 of file mathematical_types.cpp.

◆ includes()

bool integer_range_typet::includes ( const mp_integer & singleton ) const

Returns: True iff the given value lies within the closed interval [from(), to()].

Definition at line 67 of file mathematical_types.cpp.

◆ one_expr()

constant_exprt integer_range_typet::one_expr ( ) const

Returns: A constant expression of this type representing the value 1.

Remarks: Precondition: the interval must include 1, i.e. includes(1) must hold.

Definition at line 72 of file mathematical_types.cpp.

◆ size()

mp_integer integer_range_typet::size ( ) const

Returns: The number of integers in the closed interval [from(), to()], or 0 if the range is empty (i.e. from() > to()).

Definition at line 104 of file mathematical_types.cpp.

◆ to() [1/2]

mp_integer integer_range_typet::to ( ) const

Returns: The upper bound of the interval (inclusive).

Definition at line 99 of file mathematical_types.cpp.

◆ to() [2/2]

void integer_range_typet::to ( const mp_integer & to )

Definition at line 89 of file mathematical_types.cpp.

◆ zero_expr()

constant_exprt integer_range_typet::zero_expr ( ) const

Returns: A constant expression of this type representing the value 0.

Remarks: Precondition: the interval must include 0, i.e. includes(0) must hold.

Definition at line 78 of file mathematical_types.cpp.

The documentation for this class was generated from the following files:

/home/runner/work/cbmc/cbmc/src/util/mathematical_types.h
/home/runner/work/cbmc/cbmc/src/util/mathematical_types.cpp

Public Member Functions

Additional Inherited Members