Detailed Description

Train-Test Log.

Base class for objects that have the record(pars) method. Pars may contain a reference dataset; an estimation dataset; a block; ...

Definition at line 4 of file ttlog.m.

Inheritance diagram for ttlog:

Collaboration diagram for ttlog:

Public Member Functions
function	ttlog (in o)

function	record (in o, in pars)

function	allocate (in o, in tt)
	Called to pre-allocate matrices after `classlabels` and `rowlabels` are set. More...

function	get_insane_html (in o, in pars)
	Abstract. More...

function	extract_datasets (in o)
	Abstract. Generates one dataset per row, containing percentages. More...

function	get_legend (in o)
	Returns the default "Rate" string. Note that the `title` property can be used. More...

function	get_rate (in o)

function	get_unit (in o)
	Returns the unit corresponding to what it returns as rate. More...

function	get_format (in o)
	Returns format for sprintf() More...

function	get_description (in o, in flag_short)

function	setbatch (in o, in params)
	Sets several properties of an object at once. More...

function	get_methodname (in o, in flag_short)

function	get_report (in o)
	Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication. More...

function	get_html (in o, in flag_stylesheet)

function	get_params (in o, in data)
	Calls Parameters GUI. More...

function	extract_log (in o)

function	get_ancestry (in o, in flag_title)

Public Attributes
Property	flag_inc_t
	=1. Whether to increment time whenever something is recorded More...

Property	t
	"Time", incremented every time `record()` is called. Reset to zero if `allocate()` is called. More...

Property	title

Property	color

Protected Member Functions
function	do_allocate (in o, in tt)

function	do_get_report (in o)
	Default report. More...

function	do_get_html (in o)
	Abstract. HTML inner body. More...

Protected Attributes
Property	flag_allocated
	Whether `allocate()` has been called. More...

Property	no_slots
	Number of allocated slots (call to allocate()) More...

Property	classtitle
	Class Title. Should have a descriptive name, as short as possible. More...

Property	short
	Short for the method name. More...

Property	flag_params

Property	flag_ui
	(GUI setting) Whether to "publish" in blockmenu and datatool. Note that a class can be "published" without a GUI (set flag_params=0 in this case, at the class constructor). More...

Property	moreactions
	(GUI setting) String cell containing names of methods that may be called from the GUIs More...

Constructor & Destructor Documentation

function ttlog::ttlog ( in o )

Member Function Documentation

function ttlog::allocate	(	in	o,
		in	tt
	)

Called to pre-allocate matrices after classlabels and rowlabels are set.

function ttlog::do_allocate	(	in	o,
		in	tt
	)

protected

Abstract. Called to pre-allocate matrices. Must be called only when collabels and rowlabels can be resolved (reaching this varies along ttlog descendants).

function irobj::do_get_html ( in o )

protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in o )

protectedinherited

Default report.

function ttlog::extract_datasets ( in o )

Abstract. Generates one dataset per row, containing percentages.

function irobj::extract_log ( in o )

inherited

Parameters

o

Returns: [o, log]

function irobj::get_ancestry	(	in	o,
		in	flag_title
	)

inherited

Parameters

o
flag_title=1

function irobj::get_description	(	in	o,
		in	flag_short
	)

inherited

Returns description string

Precedence according with flag_short:

0: title > short > classtitle
1: short > title > classtitle

Parameters

flag_short=0 I am sealing this to make sure that no class will try to improvise on this function.

function ttlog::get_format ( in o )

Returns format for sprintf()

function irobj::get_html	(	in	o,
		in	flag_stylesheet
	)

inherited

Parameters

flag_stylesheet=1 Whether to include the stylesheet in the HTML

function ttlog::get_insane_html	(	in	o,
		in	pars
	)

Abstract.

function ttlog::get_legend ( in o )

Returns the default "Rate" string. Note that the title property can be used.

function irobj::get_methodname	(	in	o,
		in	flag_short
	)

inherited

This is used only to compose sequence string e.g. xxx->yyy->zzz

Parameters

flag_short=0

function irobj::get_params	(	in	o,
		in	data
	)

inherited

Calls Parameters GUI.

If flag_params, tries uip_<class>.m. If fails, tries uip_<ancestor>.m and so on

function ttlog::get_rate ( in o )

Returns the "default" peformance measure, to be customizable. It is "abstract" in this class (returns zero)

Note that "rate" is defined in the range 0-100, not 0-1

function irobj::get_report ( in o )

inherited

Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication.

function ttlog::get_unit ( in o )

Returns the unit corresponding to what it returns as rate.

function ttlog::record	(	in	o,
		in	pars
	)

Parameters

pars	Structure with varying fields: .ds_test ; c .est ; .clssr .

function irobj::setbatch	(	in	o,
		in	params
	)

inherited

Sets several properties of an object at once.

Parameters

o
params	Cell followint the pattern {'property1', value1, 'property2', value2, ...}

Member Data Documentation

Property irobj::classtitle

protectedinherited

Class Title. Should have a descriptive name, as short as possible.

Definition at line 50 of file irobj.m.

Property irobj::color

inherited

=[0, .8, 0]. multipurpose feature, routines may use it for different things. Major use is to change the background of objtool and blockmenu. See also classes_html.m

Definition at line 42 of file irobj.m.

Property ttlog::flag_allocated

protected

Whether allocate() has been called.

Definition at line 16 of file ttlog.m.

Property ttlog::flag_inc_t

=1. Whether to increment time whenever something is recorded

Definition at line 10 of file ttlog.m.

Property irobj::flag_params

protectedinherited

=1. (GUI setting) Whether to call a GUI when the block is selected in blockmenu.m . If true, a routine called "uip_"<class name> will be called.

Definition at line 57 of file irobj.m.

Property irobj::flag_ui

protectedinherited

(GUI setting) Whether to "publish" in blockmenu and datatool. Note that a class can be "published" without a GUI (set flag_params=0 in this case, at the class constructor).

Definition at line 60 of file irobj.m.

Property irobj::moreactions

protectedinherited

(GUI setting) String cell containing names of methods that may be called from the GUIs

Definition at line 63 of file irobj.m.

Property ttlog::no_slots

protected

Number of allocated slots (call to allocate())

Definition at line 19 of file ttlog.m.

Property irobj::short

protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property ttlog::t

"Time", incremented every time record() is called. Reset to zero if allocate() is called.

Definition at line 33 of file ttlog.m.

Property irobj::title

inherited

Definition at line 38 of file irobj.m.

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

ttlog.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation