RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::ProgressBar Class Reference

#include <ProgressBar.h>

Public Member Functions

 ProgressBar ()
 
 ProgressBar (unsigned int width, std::uint64_t numToDo)
 
 ProgressBar (const ProgressBar &)=delete
 
ProgressBaroperator= (const ProgressBar &)=delete
 
 ProgressBar (ProgressBar &&)=delete
 
ProgressBaroperator= (ProgressBar &&)=delete
 
 ~ProgressBar ()=default
 
void update (float value, std::ostream &os=std::cout)
 
void increment (std::uint64_t incr=1, std::ostream &os=std::cout)
 
void set_progress (float value)
 
void write_progress (std::ostream &os=std::cout)
 

Detailed Description

Definition at line 26 of file ProgressBar.h.

Constructor & Destructor Documentation

◆ ProgressBar() [1/4]

RDKit::ProgressBar::ProgressBar ( )
inline

Definition at line 28 of file ProgressBar.h.

Referenced by operator=(), operator=(), ProgressBar(), and ProgressBar().

◆ ProgressBar() [2/4]

RDKit::ProgressBar::ProgressBar ( unsigned int width,
std::uint64_t numToDo )
inline

Definition at line 29 of file ProgressBar.h.

◆ ProgressBar() [3/4]

RDKit::ProgressBar::ProgressBar ( const ProgressBar & )
delete

References ProgressBar().

◆ ProgressBar() [4/4]

RDKit::ProgressBar::ProgressBar ( ProgressBar && )
delete

References ProgressBar().

◆ ~ProgressBar()

RDKit::ProgressBar::~ProgressBar ( )
default

Member Function Documentation

◆ increment()

void RDKit::ProgressBar::increment ( std::uint64_t incr = 1,
std::ostream & os = std::cout )
inline

Definition at line 43 of file ProgressBar.h.

References update().

◆ operator=() [1/2]

ProgressBar & RDKit::ProgressBar::operator= ( const ProgressBar & )
delete

References ProgressBar().

◆ operator=() [2/2]

ProgressBar & RDKit::ProgressBar::operator= ( ProgressBar && )
delete

References ProgressBar().

◆ set_progress()

void RDKit::ProgressBar::set_progress ( float value)
inline

Definition at line 50 of file ProgressBar.h.

Referenced by update().

◆ update()

void RDKit::ProgressBar::update ( float value,
std::ostream & os = std::cout )
inline

Definition at line 39 of file ProgressBar.h.

References set_progress(), and write_progress().

Referenced by increment().

◆ write_progress()

void RDKit::ProgressBar::write_progress ( std::ostream & os = std::cout)
inline

Definition at line 55 of file ProgressBar.h.

Referenced by update().


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