Public Member Functions | List of all members
stan::callbacks::interrupt Class Reference

#include "stan/callbacks/interrupt.hpp"

Inheritance diagram for stan::callbacks::interrupt:
ana::StanFitter::samplecounter_callback mock_callback mock_callback mock_callback stan::test::unit::instrumented_interrupt

Public Member Functions

virtual void operator() ()
 
virtual ~interrupt ()
 

Detailed Description

interrupt is a base class defining the interface for Stan interrupt callbacks.

The interrupt is called from within Stan algorithms to allow for the interfaces to handle interrupt signals (ctrl-c).

Definition at line 14 of file interrupt.hpp.

Constructor & Destructor Documentation

virtual stan::callbacks::interrupt::~interrupt ( )
inlinevirtual

Virtual destructor.

Definition at line 28 of file interrupt.hpp.

28 {}

Member Function Documentation

virtual void stan::callbacks::interrupt::operator() ( void  )
inlinevirtual

Callback function.

This function is called by the algorithms allowing the interfaces to break when necessary.

Reimplemented in ana::StanFitter::samplecounter_callback, stan::test::unit::instrumented_interrupt, mock_callback, mock_callback, and mock_callback.

Definition at line 22 of file interrupt.hpp.

22  {
23  }

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