duckdb::ProgressData Struct Reference

Public Member Functions
double	ProgressDone () const
void	Add (const ProgressData &other)
void	Normalize (const double target=1.0)
void	SetInvalid ()
bool	IsValid () const

Public Attributes
double	done = 0.0
double	total = 0.0
bool	invalid = false

Member Function Documentation

ProgressDone()

double duckdb::ProgressData::ProgressDone ( ) const

inline

                                {
        // ProgressDone requires a valid state
        D_ASSERT(IsValid());
 
        return done / total;
    }

Add()

void duckdb::ProgressData::Add ( const ProgressData &  other )

inline

                                        {
        // Add is unchecked, propagating invalid
        done += other.done;
        total += other.total;
        invalid = invalid || other.invalid;
    }

Normalize()

void duckdb::ProgressData::Normalize ( const double  target = 1.0 )

inline

                                              {
        // Normalize checks only `target`, propagating invalid
        D_ASSERT(target > 0.0);
        if (IsValid()) {
            if (total > 0.0) {
                done /= total;
            }
            total = 1.0;
            done *= target;
            total *= target;
        } else {
            SetInvalid();
        }
    }

SetInvalid()

void duckdb::ProgressData::SetInvalid ( )

inline

                      {
        invalid = true;
        done = 0.0;
        total = 1.0;
    }

IsValid()

bool duckdb::ProgressData::IsValid ( ) const

inline

                         {
        return (!invalid) && (done >= 0.0) && (done <= total) && (total >= 0.0);
    }

---

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

• external/duckdb/duckdb.hpp