org.pdfclown.documents.functions.Function Class Reference

Function [PDF:1.6:3.9]. More...

Inheritance diagram for org.pdfclown.documents.functions.Function:

List of all members.

Public Member Functions
IList< PdfDirectObject >	Calculate (IList< PdfDirectObject > inputs)
	Gets the result of the calculation applied by this function to the specified input values.
abstract double[]	Calculate (double[] inputs)
	Gets the result of the calculation applied by this function to the specified input values.
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static Function	Wrap (PdfDirectObject baseObject)
	Wraps a function base object into a function object.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
delegate IList< Interval< T > >	DefaultIntervalsCallback< T > (IList< Interval< T >> intervals)
	Default intervals callback.
	Function (PdfDirectObject baseObject)
	Function (Document context, PdfDataObject baseDataObject)
IList< Interval< T > >	GetIntervals< T > (PdfName key, DefaultIntervalsCallback< T > defaultIntervalsCallback)
	Gets the intervals corresponding to the specified key.
virtual PdfString	RetrieveName ()
	Retrieves the name possibly associated to this object, walking through the document's name dictionary.
PdfDirectObject	RetrieveNamedBaseObject ()
	Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
Properties
virtual PdfDirectObject	BaseObject [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
PdfIndirectObject	DataContainer [get]
	Gets the indirect object containing the base data object.
PdfDictionary	Dictionary [get]
	Gets this function's dictionary.
Document	Document [get]
	Gets the document context.
IList< Interval< double > >	Domains [get]
	Gets the (inclusive) domains of the input values.
File	File [get]
	Gets the file context.
int	InputCount [get]
	Gets the number of input values (parameters) of this function.
int	OutputCount [get]
	Gets the number of output values (results) of this function.
IList< Interval< double > >	Ranges [get]
	Gets the (inclusive) ranges of the output values.

---

Function [PDF:1.6:3.9].

---

Constructor & Destructor Documentation

org.pdfclown.documents.functions.Function.Function	(	Document	context,
		PdfDataObject	baseDataObject
	)			[protected]

org.pdfclown.documents.functions.Function.Function

(

PdfDirectObject

baseObject

)

[protected]

---

Member Function Documentation

IList<PdfDirectObject> org.pdfclown.documents.functions.Function.Calculate

(

IList< PdfDirectObject >

inputs

)

Gets the result of the calculation applied by this function to the specified input values.

Parameters:

inputs

Input values.

abstract double [] org.pdfclown.documents.functions.Function.Calculate

(

double[]

inputs

)

[pure virtual]

Gets the result of the calculation applied by this function to the specified input values.

Parameters:

inputs

Input values.

Implemented in org.pdfclown.documents.functions.Type0Function, org.pdfclown.documents.functions.Type2Function, org.pdfclown.documents.functions.Type3Function, and org.pdfclown.documents.functions.Type4Function.

void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility

(

object

feature

)

[protected, inherited]

Checks whether the specified feature is compatible with the document's conformance version.

Parameters:

feature

Entity whose compatibility has to be checked. Supported types: VersionEnum Property name resolvable to an annotated getter method MemberInfo

virtual object org.pdfclown.objects.PdfObjectWrapper.Clone

(

Document

context

)

[virtual, inherited]

Gets a clone of the object, registered inside the given document context.

Parameters:

context

Which document the clone has to be registered in.

delegate IList<Interval<T> > org.pdfclown.documents.functions.Function.DefaultIntervalsCallback< T >

(

IList< Interval< T >>

intervals

)

[protected]

Default intervals callback.

Type Constraints

T

:

IComparable<T>

virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete

(

)

[virtual, inherited]

Removes the object from its document context.

The object is no more usable after this method returns.

Returns:

Whether the object was actually decontextualized (only indirect objects can be decontextualize).

override bool org.pdfclown.objects.PdfObjectWrapper.Equals

(

object

obj

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDataObject >

wrapper

)

[static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

IList<Interval<T> > org.pdfclown.documents.functions.Function.GetIntervals< T >	(	PdfName	key,
		DefaultIntervalsCallback< T >	defaultIntervalsCallback
	)			[protected]

Gets the intervals corresponding to the specified key.

Type Constraints

T

:

IComparable<T>

virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName

(

)

[protected, virtual, inherited]

Retrieves the name possibly associated to this object, walking through the document's name dictionary.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject

(

)

[protected, inherited]

Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.

static Function org.pdfclown.documents.functions.Function.Wrap

(

PdfDirectObject

baseObject

)

[static]

Wraps a function base object into a function object.

Parameters:

baseObject

Function base object.

Returns:

Function object associated to the base object.

References org.pdfclown.objects.PdfObject.Resolve().

---

Property Documentation

virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited]

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited]

Gets the indirect object containing the base object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited]

Gets the indirect object containing the base data object.

PdfDictionary org.pdfclown.documents.functions.Function.Dictionary [get, protected]

Gets this function's dictionary.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

IList<Interval<double> > org.pdfclown.documents.functions.Function.Domains [get]

Gets the (inclusive) domains of the input values.

Input values outside the declared domains are clipped to the nearest boundary value.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

int org.pdfclown.documents.functions.Function.InputCount [get]

Gets the number of input values (parameters) of this function.

int org.pdfclown.documents.functions.Function.OutputCount [get]

Gets the number of output values (results) of this function.

IList<Interval<double> > org.pdfclown.documents.functions.Function.Ranges [get]

Gets the (inclusive) ranges of the output values.

Output values outside the declared ranges are clipped to the nearest boundary value; if this entry is absent, no clipping is done.

Returns:

null

in case of unbounded ranges.