Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Latest commit

 

History

History
437 lines (383 loc) · 12.2 KB

components.md

File metadata and controls

437 lines (383 loc) · 12.2 KB
Raw

Components

Table of avaliable components.

Name Short name ID Prediction Mixer input
StateMapContext SMC 1 yes yes
APM1 APM1 2 yes no
DynamicStateMap DS 3 yes no
AvgMap AVG 4 yes no
SmallStationaryContextMap SCM 5 no yes
RunContextMap RCM 6 no yes
ContextMap CM 7 no yes
Mixer MX 8 yes no
StaticMap ST 9 yes yes
MixMap MM 10 no yes
DynamicHashStateMap DHS 11 yes no
StationaryMap SM 12 no yes
SkMap SK 13 no yes
APM2 APM2 2 yes no
ERR ERR 15 no no
TAPM TAPM 16 yes no
UAS UAS 17 yes no
LMX LMX 18 yes no
STA STA 19 no no
BYT BYT 20 no no

Yes in prediction means that component outputs prediction into internal array pr[]

Yes in mixer input means that component outputs prediction into internal array inputs[], witch is used in MX component as inputs.

If both are yes then only one output can be selected in vmi function.

Functions used to set up components

vms - component counts

vms(countOfSMC,countOfAPM1,countOfDS,...);

component counts, 11 parameters with ID order, like in Components table below. Only usable in function main()

// use:
// 0 SMC, 1 APM1,1 DS, 2 AVG, 0 ...
vms(0,1,1,2,0,0,0,0,0);

vmi - initialize component

vmi(Component,Index,parameter1,parameter2,parameter2);

or

vmi(Component,Index,parameter1,parameter2,inputsIndex);

initialize component upto number specified in vms. Only usable in function main()

vmx - set component context

vmx(Component,Index,Context);

set component context. Only usable in function update(...)

// Set APM1(0) context = c0
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is context
vmx(APM1,index,c0);

Individual components

SMC

// Create SMC component (0) - StateMapContext
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is memory size
// forth parameter is limit=1...1023
// fifth parameter is output (pr index=-1,MX input=0...MX)
//                    output=-1 use pr[index] where index=0...lastComponent
//                    output>=0 select MX component as output
//
// vmi(SMC,index,size,limit,output);

Prediction to mixer:

// in update
vmx(SMC,0,val1);      //  set component SMC(0) context to val1
vmx(SMC,1,val2);      //  set component SMC(1) context to val2
// in main
vmi(SMC,0,0x10,1023,0);  //  mixer[0].add(smc(0).p())
vmi(SMC,1,0x10,1023,0);  //  mixer[0].add(smc(1).p())

Direct prediction:

// in update
vmx(SMC,0,val1);      //  set component SMC(0) context to val1
vmx(SMC,1,val2);      //  set component SMC(1) context to val2
// in main
vmi(SMC,0,0x10,1023,-1);  //  pr[0]=smc(0).predict()
vmi(SMC,1,0x10,1023,-1);  //  pr[1]=smc(1).predict()

APM1

// Create APM1 component (0) - Adaptive Probability Map
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is size
// forth parameter is rate
// fifth parameter is predictionIndex
//
// vmi(APM1,index,size,rate,predictionIndex);

// in update
vmx(SMC,0,val1);          //  set component SMC(0) context to val1
vmx(APM1,0,val2);      //  set component APM1(0) context to val2
// in main
vmi(SMC,0,0x10,1023,-1);  //  pr[0]=smc(0).predict()
vmi(APM1,0,0x1000,7,0);   //  pr[1]=apm(pr[0])

DS

// Create DS component (0) - Dynamic StateMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is number of memory bits x in lower 16 bits, and statetable index y in upper 16 bits
// forth parameter is limit for statetable, default 1023
// fifth parameter is number of contexts N
vmi(DS,0,x+y*0x10000,1023,N);

AVG

// Create AVG component (0) - Average Map
// Calculate average and output prediction - pr[3]=(pr[1]+pr[2]+1)>>1
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is average parameters x and y where pr[next]=(pr[z]*x+pr[w]*y+1)>>(x+y)
// forth not used, set 0
// fifth parameter is index into pr[] array as z and w
vmi(AVG,0,x+y*256,0,z+w*256);

SCM

// Create SCM component (0) - Small Stationary ContextMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is input size in bits
// forth parameter is nil
// fifth parameter is mixer index
vmi(SCM,0,8,0,0);  // input is 8 bits, use mixer 0

RCM

// Create RCM component (0) - Run ContextMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is memory*4096, must be power of two
// forth parameter is unused
// fifth parameter is predictionIndex
vmi(RCM,0,1024,0,0);

CM

// Create CM component (0) - ContextMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is memory*4096 in lower 24 bits (must be power of two), and statetable index si in upper 8 bits (si=0 is default STA)
// forth parameter is:
//                   count of contexts x, 
//                   run mul y (default 4), 
//                   mixer prediction mul z (default 32) and w (dafault 12),
//                   v (default 8) and u (dafault 32). 
// fifth parameter is: mixer index mi
// Parameters y, z, w, v, u are tunable.

//main
//
vmi(CM,0,memory*4096+(si<<24),x+y*0x100+z*0x10000+w*0x1000000,mi+v*0x100+u*0x10000);

MX

// Create MX component (0) - Mixer
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is shift (dafault 64), error (dafault 0), mul (dafault 28), all tunable
// forth parameter is context size
// fifth parameter is mixer index

// Update:
//  err=((y<<12)-pr)*mul/4;
    if (err>=-error && err<=error) err=0;
    train(..., err);
// Predict:
//  dot_product(...)*shift>>11;

vmi(MX,0,shift+256*error+0x1000000*mul,1,0);

ST

// Create ST component (0) - Statc Prediction
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is value m where pr=((m-128)*16) if fift parameter is -1, or pr=(m*16) if 0
// forth parameter is nil
// fifth parameter is output (pr index=-1,MX input=0...MX)
//                    output=-1 use pr[index] where index=0...lastComponent
//                    output>=0 select MX component as output

//main
//
vmi(ST,0,144,0,0);

MM

// Create MM component (0) - Mixer Map
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is option:
//         0 adds stretch(pr) to mixer
//         1 adds stretch(pr) >> 1  to mixer
//         3...x  (pr-2048 >> 3...x) to mixer
// forth parameter is pr index
// fifth parameter is mixer index
// mixer[2].add(strech(pr[1]))
vmi(MM,0,0,1,2);

DHS

// Create DHS component (0) - Dynamic Hash StateMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is input bits in lower 16 bits, and statetable index in upper 16 bits
// forth parameter is memory bits, memory usage is ((1<<bits)*(1<<memory))
// fifth parameter is number of contexts

//main
// creates DHS with 10 context using 256MB of memory where state count per context is 16 (1<<4)
vmi(DHS,0,4,24,10);

// update
// set DHS contexts at the start of state update
for ( i=0; i<10; i++) {  vmx(DHS,0,cxt[i]);}

// update DHS contexts states where j is in range 0...16
vmx(DHS,0,j);

SM

// Create SM component (0) - StationaryMap
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is memory_bits
// forth parameter is input_bits (low 8 bits), memory usage is N=((1<<memory_bits)*((1<<input_bits)-1)). pr mul value
// fifth parameter is number of contexts

//main
// creates SM
vmi(SM,0,16,3,0);

// update
// set SM contexts at the start of state update
vmx(SM, 0,val);

SK

// Create SK component (0) - Direct prediction
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is nil
// forth parameter is nil
// fifth parameter is mixer index

//main
// creates SK
vmi(SK,0,0,0,0);

// update
// set SK value to be added to mixer, range -2047..2047
vmx(SK, 0,val);

APM2

// Create APM2 component (0) - Adaptive Probability Map
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is size
// forth parameter is x
// fifth parameter is predictionIndex
//
// vmi(APM1,index,size,rate,predictionIndex);

// in update
vmx(SMC,0,val1);          //  set component SMC(0) context to val1
vmx(APM2,0,val2);      //  set component APM1(0) context to val2
// in main
vmi(SMC,0,0x10,1023,-1);  //  pr[0]=smc(0).predict()
vmi(APM2,0,0x1000,7,0);   //  pr[1]=apm(pr[0])

ERR

// Create ERR component (0) - Error Treshold
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is x and y, where x is first input and y is second input in range 0...4095. x and y parameters is tunable.
// forth parameter is nil
// fifth parameter is nil
// output: based on input tresholds output values are 1 or 3. 
//         1 - val>x (for low)
//         3 - val>y (for high)

//main
// creates SM
vmi(ERR,0,x+(y<<16),0,0);

// update
// set ERR value
val=y?pr^4095:pr;
a=vmx(ERR, 0,val);

TAPM

Obsolete component.

UAS

// Create UAS component (0) - Unaligned Sparse Map
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is x, input size in bits. x parameter is tunable.
// forth parameter is y, input mask - ignored
// fifth parameter is z, update rate, dafault 5
// output: prediction when last 8 bits of val are set, otherwise prediction is 2048

//main
// creates UAS
vmi(UAS,0,x,y,z);
for (i=0;i<8;i++) vmi(ERR,i,e_low[i]+(e_high[i]<<16),0,0);

// update
// set UAS value, where val is shifted output of component ERR outputs
val=y?pr^4095:pr;
a=vmx(ERR, bpos,val); // ERR component for every bit pos
erra=(erra<<1)|(a&1);
if (bpos==0){ 
    val=erra;
}

vmx(UAS, 0,val);

LMX

// Create LMX component (0) - Linear Mixer
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is x and y, where x is first input and y is second input 
// forth parameter is weight z, if z==0 default value is 2048. z parameter is tunable.
// fifth parameter is nil
// output: x+(((z-x)*w)>>12);

//main
// creates LMX
vmi(LMX,0,x+y*256,z,0);

// update
// :none

STA

// Create STA component (0) - State Table
// 
// first parameter is component ID
// second parameter is component index upto number defined in vms.
// third parameter is u and v (in range 1-63)
// forth parameter is w and x (in range 1-63)
// fifth parameter is y, z and u (y range 1-63) (z range 1-32) (u range 2-32) 
// output: generates statetable;
//         if parameters==0 use default values as 42,41,13,6,5,16,14

//main
// creates STA
vmi(STA,0,u+v*0x10000,w+x*0x10000,y+z*0x10000+u*0x1000000);
// use STA (1<<24) in CM(0), with 2*4096 memory, one context, output to MX(0)
vmi(CM,0,2*4096+(1<<24),1,0);
// create MX(0) with default parameters, context size is 1
vmi(MX,0,0,1,0);
// update
// :none

BYT

// Create BYT component (0) - Byte Table
// Map byte value to new value in tune mode, otherwise output is same as input. 
// Useful in model creation fase. Grouping chars, automatic "best" context selection for CM.
//
// first parameter is component ID
// second parameter is component index upto number defined in vms
// third parameter is value x in range 0-255, tunable
// forth parameter is value y of output range, must be between value x
// fifth parameter is nil

//main
// creates BYT with value x
vmi(BYT,0,x,y,0);

// update
// get BYT value based on input val
a=vmx(BYT, 0,val);