com.github.mrdimosthenis.synapses

Class Codec

java.lang.Object

com.github.mrdimosthenis.synapses.Codec

public class Codec
extends java.lang.Object

The constructors and methods of codecs.

Create a codec:

 
 Map<String, String> setosa = Map.of(
      "petal_length", "1.5",
      "species", "setosa"
 );

 Map<String, String> versicolor = Map.of(
      "petal_length", "3.8",
      "species", "versicolor"
 );

 Stream dataset = Arrays.stream(new Map[]{setosa, versicolor});

 Attribute[] attributes = {
      new Attribute("petal_length", false),
      new Attribute("species", true)
 };

 Codec codec = new Codec(attributes, dataset);
 
 

Encode a data point:

 
 codec.encode(setosa);
 
 

Decode a data point:

 
 codec.decode(new double[]{0.0, 1.0, 0.0});
 
 

Get the JSON representation of the codec:

 
 codec.json();
 
 

Constructor Summary

Constructors

Constructor and Description
Codec(Attribute[] attributes, java.util.stream.Stream<java.util.Map<java.lang.String,java.lang.String>> datapoints) Creates a codec by consuming a stream of data points.
Codec(java.lang.String json) Creates a codec by parsing its JSON representation.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	decode(double[] encodedValues) Decodes a data point.
double[]	encode(java.util.Map<java.lang.String,java.lang.String> datapoint) Encodes a data point.
java.lang.String	json() The JSON representation of the codec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Codec

public Codec(Attribute[] attributes,
             java.util.stream.Stream<java.util.Map<java.lang.String,java.lang.String>> datapoints)

Creates a codec by consuming a stream of data points.

Parameters:

attributes - An array of attributes that defines their names and types (discrete or not).

datapoints - A stream that contains the data points.

Codec

public Codec(java.lang.String json)

Creates a codec by parsing its JSON representation.

Parameters:

json - The JSON representation of a codec.

Method Detail

encode

public double[] encode(java.util.Map<java.lang.String,java.lang.String> datapoint)

Encodes a data point.

Parameters:

datapoint - A data point as a map of strings.

Returns:

The encoded data point as an array of numbers between 0.0 and 1.0.

decode

public java.util.Map<java.lang.String,java.lang.String> decode(double[] encodedValues)

Decodes a data point.

Parameters:

encodedValues - An encoded data point as an array of numbers between 0.0 and 1.0.

Returns:

The decoded data point as a map of strings.

json

public java.lang.String json()

The JSON representation of the codec.

Returns:

The JSON representation of the codec.