log_cube Class Reference

Detailed Description

Log generated by a reptt_blockcube.

This has a 4-D cell of irlog

Each slice logs(:, :, :, i) accounts for a different log class

See also

reptt_blockcube

Definition at line 9 of file log_cube.m.

Inheritance diagram for log_cube:

Collaboration diagram for log_cube:

Public Member Functions
function	log_cube ()
function	extract_sovalues (in o)
function	allocate_logs (in o, in log_mold, in block_mold, in no_reps)
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	logs
Property	blocks
Property	title
Property	color

Protected Member Functions
function	do_get_report (in o)
	Default report. More...
function	do_get_html (in o)
	Abstract. HTML inner body. More...

Protected Attributes
Property	no_datasets
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 log_cube::log_cube

(

)

Member Function Documentation

function log_cube::allocate_logs	(	in	o,
		in	log_mold,
		in	block_mold,
		in	no_reps
	)

Pre-allocates the log property; prepares to record.

Parameters

log_mold	a cell of irlog objects
block_mold	a cell of block objects. Only used to get allocation dimensions
no_reps	Number of repetitions, such as "k" from a k-fold cross-validation

function irobj::do_get_html ( in  o )

protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in  o )

protectedinherited

Default report.

function irobj::extract_log ( in  o )

inherited

Parameters

o

Returns

[o, log]

function log_cube::extract_sovalues

(

in

o

)

Creates a sovalues object

Only works if the log_cube::logs property has dimension [n, 1, 1, *]

Returns

a sovalues object

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 irobj::get_html ( in  o, in  flag_stylesheet  )

inherited

Parameters

flag_stylesheet=1

Whether to include the stylesheet in the HTML

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 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 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 log_cube::blocks

Definition at line 16 of file log_cube.m.

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 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 log_cube::logs

Definition at line 14 of file log_cube.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 log_cube::no_datasets

protected

Definition at line 21 of file log_cube.m.

Property irobj::short

protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property irobj::title

inherited

Definition at line 38 of file irobj.m.

---

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

• log_cube.m