Into

Modules

Documentation

classPiiLogOperation

#include <PiiLogOperation.h>

An operation that calculates the logarithm of its input.

Inherits PiiDefaultOperation

Description

Inputs

inputany number or numeric matrix.

Outputs

outputthe logarithm as a double scalar or a double matrix.

Properties

double

The base of the logarithm.

Constructors and destructor

Public member functions

double
( )
void
(
  • double base
)

Protected member functions

virtual void

Executes one round of processing.

Property details

  • double base

    [read, write]

    The base of the logarithm.

    The default value is e.

Function details

  • PiiLogOperation

    ()
  • double base

    ()
  • void setBase

    (
    • double base
    )
  • virtual void process

    ()
    [protected, virtual]

    Executes one round of processing.

    This function is invoked by the processor if the necessary preconditions for a new processing round are met. This function does all the necessary calculations to create output objects and sends them to output sockets.

    Calls to process(), syncEvent(), and setProperty() are synchronized and cannot occur simultaneously. PiiDefaultOperation ensures this by locking processLock() for reading before calling process().

    Note: With time-consuming operations, one should occasionally check that the operation hasn't been interrupted, i.e. that state() returns Running.

    Exceptions
    PiiExecutionException

    whenever an unrecoverable error occurs during a processing round, the operation is interrupted, or finishes execution due to end of input data.

    Reimplemented from PiiDefaultOperation.

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.