Inheritance diagram for com::avpkit::core::Rational:

Collaboration diagram for com::avpkit::core::Rational:

[legend]

Public Member Functions
virtual IRational *	copy ()
	Creates a new IRational object by copying (by value) this object. More...

virtual int32_t	getNumerator ()
	Get the numerator for this rational. More...

virtual int32_t	getDenominator ()
	Get the denominator for this rational. More...

virtual int32_t	compareTo (IRational *other)
	Compare a rational to this rational. More...

virtual double	getDouble ()
	Rational to double conversion. More...

virtual int32_t	reduce (int64_t num, int64_t den, int64_t max)
	Reduce a fraction to it's lowest common denominators. More...

virtual IRational *	multiply (IRational *arg)
	Multiplies this number by arg. More...

virtual IRational *	divide (IRational *arg)
	Divides this rational by arg. More...

virtual IRational *	subtract (IRational *arg)
	Subtracts arg from this rational. More...

virtual IRational *	add (IRational *arg)
	Adds arg to this rational. More...

virtual int64_t	rescale (int64_t origValue, IRational *origBase)
	Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational. More...

virtual int64_t	rescale (int64_t origValue, IRational *origBase, Rounding rounding)
	Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational. More...

virtual void	setNumerator (int32_t value)
	Sets the numerator on this object. More...

virtual void	setDenominator (int32_t value)
	Sets the denominator on this object. More...

virtual void	setValue (double value)
	Sets the numerator and denominator on this object by reducing the double to the closest integer numerator and denominator. More...

virtual double	getValue ()
	An alias for getDouble() but matching JavaBean conventions. More...

virtual bool	isFinalized ()
	Returns true if init() has been called and this object is now considered finalized and immutable. More...

virtual void	init ()
	Marks this object as finalized and immutable. More...

Public Member Functions inherited from com::avpkit::ferry::RefCounted
virtual int32_t	acquire ()
	Internal Only. More...

virtual int32_t	release ()
	Internal Only. More...

virtual RefCounted *	copyReference ()
	Create a new Java object that refers to the same native object. More...

virtual int32_t	getCurrentRefCount ()
	Return the current reference count on this object. More...

void	setJavaAllocator (void *allocator)
	This method is public but not part of the standard API. More...

void *	getJavaAllocator ()
	This method is public but not part of the standard API. More...

Static Public Member Functions
static Rational *	make (double d)
	Converts a double precision floating point number to a rational. More...

static Rational *	make (AVRational *src)
	Create a Rational from an AVRational struct. More...

static Rational *	make (Rational *src)
	Creates copy of a Rational from another Rational. More...

static Rational *	make (int32_t num, int32_t den)
	Create a rational from a numerator and denominator. More...

static int64_t	rescale (int64_t srcValue, int32_t dstNumerator, int32_t dstDenominator, int32_t srcNumerator, int32_t srcDenominator, Rounding rounding)

Static Public Member Functions inherited from com::avpkit::core::IRational
static int32_t	sCompareTo (IRational a, IRational b)
	Compare two rationals. More...

static int32_t	sReduce (IRational *dst, int64_t num, int64_t den, int64_t max)
	Reduce a fraction to it's lowest common denominators. More...

static IRational *	sMultiply (IRational a, IRational b)
	Multiples a by b. More...

static IRational *	sDivide (IRational a, IRational b)
	Divides a by b. More...

static IRational *	sSubtract (IRational a, IRational b)
	Subtracts a from b. More...

static IRational *	sAdd (IRational a, IRational b)
	Adds a to b. More...

static int64_t	sRescale (int64_t origValue, IRational origBase, IRational newBase)
	Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational. More...

static IRational *	make ()
	Get a new rational that will be set to 0/0. More...

static IRational *	make (double d)
	Converts a double precision floating point number to a rational. More...

static IRational *	make (IRational *src)
	Creates deep copy of a Rational from another Rational. More...

static IRational *	make (int32_t num, int32_t den)
	Create a rational from a numerator and denominator. More...

static int64_t	sRescale (int64_t origValue, IRational origBase, IRational newBase, Rounding rounding)
	Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational. More...

static int64_t	rescale (int64_t srcValue, int32_t dstNumerator, int32_t dstDenominator, int32_t srcNumerator, int32_t srcDenominator, Rounding rounding)
	Rescales a long value to another long value. More...

Additional Inherited Members
Public Types inherited from com::avpkit::core::IRational
enum	Rounding { ROUND_ZERO = 0 , ROUND_INF = 1 , ROUND_DOWN = 2 , ROUND_UP = 3 , ROUND_NEAR_INF = 5 }

typedef enum com::avpkit::core::IRational::Rounding	Rounding

Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.

Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.

void *	mAllocator
	Not part of public API.

Detailed Description

Definition at line 29 of file Rational.h.

Member Function Documentation

◆ add()

IRational * com::avpkit::core::Rational::add ( IRational * arg )

virtual

Adds arg to this rational.

Parameters

arg	The amount to add to this.

Returns: this+arg.

Implements com::avpkit::core::IRational.

Definition at line 227 of file Rational.cpp.

   {
     Rational *result = 0;
     Rational *arg=dynamic_cast<Rational*>(other);
     if (arg)
     {
       result = Rational::make();
       if (result)
       {
         result->mRational = av_add_q(this->mRational,
             arg->mRational);
       }
     }
     return result;
   }

References com::avpkit::core::IRational::make().

◆ compareTo()

int32_t com::avpkit::core::Rational::compareTo ( IRational * other )

virtual

Compare a rational to this rational.

Parameters

other second rational

Returns: 0 if this==other, 1 if this>other and -1 if this<other.

Implements com::avpkit::core::IRational.

Definition at line 141 of file Rational.cpp.

   {
     int32_t result = 0;
     Rational *arg=dynamic_cast<Rational*>(other);
     if (arg)
       result = av_cmp_q(mRational, arg->mRational);
     return result;
   }

◆ copy()

IRational * com::avpkit::core::Rational::copy ( )

virtual

Creates a new IRational object by copying (by value) this object.

Returns: the new object

Implements com::avpkit::core::IRational.

Definition at line 92 of file Rational.cpp.

   {
     return Rational::make(this);
   }

References com::avpkit::core::IRational::make().

◆ divide()

IRational * com::avpkit::core::Rational::divide ( IRational * arg )

virtual

Divides this rational by arg.

Parameters

arg	The divisor to use.

Returns: this/arg.

Implements com::avpkit::core::IRational.

Definition at line 194 of file Rational.cpp.

   {
     Rational *result = 0;
     Rational *arg=dynamic_cast<Rational*>(other);
     if (arg)
     {
       result = Rational::make();
       if (result)
       {
         result->mRational = av_div_q(this->mRational,
             arg->mRational);
       }
     }
     return result;
   }

References com::avpkit::core::IRational::make().

◆ getDenominator()

virtual int32_t com::avpkit::core::Rational::getDenominator ( )

inlinevirtual

Get the denominator for this rational.

Returns: the denominator.

Implements com::avpkit::core::IRational.

Definition at line 37 of file Rational.h.

37 { return mRational.den; }

◆ getDouble()

double com::avpkit::core::Rational::getDouble ( )

virtual

Rational to double conversion.

Returns: (double) a

Implements com::avpkit::core::IRational.

Definition at line 151 of file Rational.cpp.

   {
     double result = 0;
     // On some runs in Linux calling av_q2d will raise
     // a FPE instead of returning back NaN or infinity,
     // so we try to short-circuit that here.
     if (mRational.den == 0)
       if (mRational.num == 0)
         result = std::numeric_limits<double>::quiet_NaN();
       else
         result = std::numeric_limits<double>::infinity();
     else
       result =  av_q2d(mRational);
     return result;
   }

Referenced by getValue().

◆ getNumerator()

virtual int32_t com::avpkit::core::Rational::getNumerator ( )

inlinevirtual

Get the numerator for this rational.

Returns: the numerator.

Implements com::avpkit::core::IRational.

Definition at line 36 of file Rational.h.

36 { return mRational.num; }

◆ getValue()

double com::avpkit::core::Rational::getValue ( )

virtual

An alias for getDouble() but matching JavaBean conventions.

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 71 of file Rational.cpp.

   {
     return getDouble();
   }

References getDouble().

◆ init()

void com::avpkit::core::Rational::init ( )

virtual

Marks this object as finalized and immutable.

Any setters called after the first init() call will be ignored.

Most make methods will call this method automatically, with the exception of the blank factory method make().

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 41 of file Rational.cpp.

   {
     if (!mInitialized) {
       (void) reduce(mRational.num,
           mRational.den,
           FFMAX(mRational.den, mRational.num));
     }
     mInitialized = true;
   }

References reduce().

Referenced by make().

◆ isFinalized()

bool com::avpkit::core::Rational::isFinalized ( )

virtual

Returns true if init() has been called and this object is now considered finalized and immutable.

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 124 of file Rational.cpp.

   {
     return mInitialized;
   }

◆ make() [1/4]

Rational * com::avpkit::core::Rational::make ( AVRational * src )

static

Create a Rational from an AVRational struct.

Parameters

src	The source AVRational object.

Returns: A new Rational; caller must release() when done. Null if src is null.

Definition at line 77 of file Rational.cpp.

   {
     Rational *result=0;
     if (src)
     {
       result = Rational::make();
       if (result) {
         result->mRational = *src;
         result->init();
       }
     }
     return result;
   }

References init(), and com::avpkit::core::IRational::make().

◆ make() [2/4]

Rational * com::avpkit::core::Rational::make ( double d )

static

Converts a double precision floating point number to a rational.

Parameters

d	double to convert

Returns: A new Rational; caller must release() when done.

Definition at line 52 of file Rational.cpp.

   {
     Rational *result=0;
     result = Rational::make();
     if (result) {
       result->setValue(d);
       result->init();
     }
     return result;
   }

References init(), com::avpkit::core::IRational::make(), and setValue().

◆ make() [3/4]

Rational * com::avpkit::core::Rational::make	(	int32_t	num,
		int32_t	den
	)

static

Create a rational from a numerator and denominator.

We will always reduce this to the lowest num/den pair we can, but never having den exceed what was passed in.

Parameters

num	The numerator of the resulting Rational
den	The denominator of the resulting Rational

Returns: A new Rational; caller must call release.

Definition at line 129 of file Rational.cpp.

   {
     Rational *result=0;
     result = Rational::make();
     if (result) {
       result->setNumerator(num);
       result->setDenominator(den);
       result->init();
     }
     return result;
   }

References init(), com::avpkit::core::IRational::make(), setDenominator(), and setNumerator().

◆ make() [4/4]

Rational * com::avpkit::core::Rational::make ( Rational * src )

static

Creates copy of a Rational from another Rational.

Note: This is a NEW object. To just keep tabs on the original, use acquire() to keep a reference.

Parameters

src	The source Rational to copy.

Returns: A new Rational; caller must call release. Returns null if src is null.

Definition at line 98 of file Rational.cpp.

   {
     Rational *result=0;
     if (src)
     {
       result = Rational::make();
       if (result) {
         result->mRational = src->mRational;
         result->init();
       }
     }
     return result;
   }

References init(), and com::avpkit::core::IRational::make().

◆ multiply()

IRational * com::avpkit::core::Rational::multiply ( IRational * arg )

virtual

Multiplies this number by arg.

Parameters

arg	number to mulitply by.

Returns: this*arg.

Implements com::avpkit::core::IRational.

Definition at line 177 of file Rational.cpp.

   {
     Rational *result = 0;
     Rational *arg=dynamic_cast<Rational*>(other);
     if (arg)
     {
       result = Rational::make();
       if (result)
       {
         result->mRational = av_mul_q(this->mRational,
             arg->mRational);
       }
     }
     return result;
   }

References com::avpkit::core::IRational::make().

◆ reduce()

int32_t com::avpkit::core::Rational::reduce	(	int64_t	num,
		int64_t	den,
		int64_t	max
	)

virtual

Reduce a fraction to it's lowest common denominators.

This is useful for framerate calculations.

Parameters

num	the src numerator.
den	the src denominator.
max	the maximum allowed for nom & den in the reduced fraction.

Returns: 1 if exact, 0 otherwise

Implements com::avpkit::core::IRational.

Definition at line 168 of file Rational.cpp.

   {
     int32_t result = 0;
     result =  av_reduce(&mRational.num, &mRational.den,
         num, den, max);
     return result;
   }

Referenced by init().

◆ rescale() [1/2]

int64_t com::avpkit::core::Rational::rescale	(	int64_t	origValue,
		IRational *	origBase
	)

virtual

Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational.

Parameters

origValue	The original int64_t value you care about.
origBase	The original base Rational that origValue is scaled with.

Returns: The new integer value, scaled in units of this IRational.

Implements com::avpkit::core::IRational.

Definition at line 244 of file Rational.cpp.

   {
     int64_t retval=origValue;
     Rational *arg=dynamic_cast<Rational*>(origBase);
  
     if (arg)
     {
       retval = av_rescale_q(origValue, arg->mRational, this->mRational);
     }
     return retval;
   }

Referenced by com::avpkit::core::IRational::rescale().

◆ rescale() [2/2]

int64_t com::avpkit::core::Rational::rescale	(	int64_t	origValue,
		IRational *	origBase,
		Rounding	rounding
	)

virtual

Takes a value scaled in increments of origBase and gives the equivalent value scaled in terms of this Rational.

Parameters

origValue	The original int64_t value you care about.
origBase	The original base Rational that origValue is scaled with.
rounding	How you want rounding to occur

Returns: The new integer value, scaled in units of this IRational.

Implements com::avpkit::core::IRational.

Definition at line 257 of file Rational.cpp.

   {
     int64_t retval=origValue;
     Rational *arg=dynamic_cast<Rational*>(origBase);
  
     if (arg)
     {
       int64_t b = arg->mRational.num  * (int64_t)this->mRational.den;
       int64_t c = this->mRational.num * (int64_t)arg->mRational.den;
  
       retval = av_rescale_rnd(origValue, b,
           c, (enum AVRounding)rounding);
     }
     return retval;
   }

◆ setDenominator()

void com::avpkit::core::Rational::setDenominator ( int32_t value )

virtual

Sets the denominator on this object.

If isFinalized is true, then this method is ignored.

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 118 of file Rational.cpp.

   {
     if (!mInitialized)
       mRational.den = den;
   }

Referenced by make().

◆ setNumerator()

void com::avpkit::core::Rational::setNumerator ( int32_t value )

virtual

Sets the numerator on this object.

If isFinalized is true, then this method is ignored.

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 112 of file Rational.cpp.

   {
     if (!mInitialized)
       mRational.num = num;
   }

Referenced by make().

◆ setValue()

void com::avpkit::core::Rational::setValue ( double value )

virtual

Sets the numerator and denominator on this object by reducing the double to the closest integer numerator and denominator.

If isFinalized is true, then this method is ignored.

Since: 3.2

Implements com::avpkit::core::IRational.

Definition at line 64 of file Rational.cpp.

   {
     if (!mInitialized)
       mRational = av_d2q(d, 0x7fffffff);
   }

Referenced by make().

◆ subtract()

IRational * com::avpkit::core::Rational::subtract ( IRational * arg )

virtual

Subtracts arg from this rational.

Parameters

arg	The amount to subtract from this.

Returns: this-arg.

Implements com::avpkit::core::IRational.

Definition at line 211 of file Rational.cpp.

   {
     Rational *result = 0;
     Rational *arg=dynamic_cast<Rational*>(other);
     if (arg)
     {
       result = Rational::make();
       if (result)
       {
         result->mRational = av_sub_q(this->mRational,
             arg->mRational);
       }
     }
     return result;
   }

References com::avpkit::core::IRational::make().

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

csrc/com/avpkit/core/Rational.h
csrc/com/avpkit/core/Rational.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ compareTo()

◆ copy()

◆ divide()

◆ getDenominator()

◆ getDouble()

◆ getNumerator()

◆ getValue()

◆ init()

◆ isFinalized()

◆ make() [1/4]

◆ make() [2/4]

◆ make() [3/4]

◆ make() [4/4]

◆ multiply()

◆ reduce()

◆ rescale() [1/2]

◆ rescale() [2/2]

◆ setDenominator()

◆ setNumerator()

◆ setValue()

◆ subtract()