SNAB Namespace Reference

Classes
class	BenchmarkExec
class	GroupMaxFreqToGroup
class	GroupMaxFreqToGroupAllToAll
class	GroupMaxFreqToGroupProb
class	LateralInhibWTA
class	MaxInputAllToAll
class	MaxInputFixedInConnector
class	MaxInputFixedOutConnector
class	MaxInputOneToOne
class	MirrorInhibWTA
class	MNIST_BASE
class	MnistCNNPool
class	MnistDiehl
class	MnistDoubleCNN
class	MnistITL
class	MnistITLLastLayer
class	MnistNAS129
class	MnistNAS63
class	MnistNAStop
class	MnistSpikey
class	OutputFrequencyMultipleNeurons
class	OutputFrequencySingleNeuron
class	OutputFrequencySingleNeuron2
class	ParameterSweep
class	RateBasedWeightDependentActivation
class	RefractoryPeriod
class	SetupTimeAllToAll
class	SetupTimeOneToOne
class	SetupTimeRandom
class	SimpleWTA
class	SingleMaxFreqToGroup
class	SNABBase
	Virtual Base class for SNABs(Benchmarks). All SNABs should have seperate building of networks, execution and an evaluation tasks. More...
class	Utilities
	Collection of usefull Utilities not directly related to spiking networks. More...
class	WeightDependentActivation

Functions
cypress::Real	NaN ()
	Used to indicate bad or invalid results. More...
std::vector< std::shared_ptr< SNABBase > >	snab_registry (std::string backend, size_t bench_index)
template<typename T >
std::map< std::string, T >	json_to_map (const cypress::Json &obj)
template<typename T >
std::vector< T >	read_check (std::map< std::string, T > &input, const std::vector< std::string > &names, const std::vector< T > &defaults)
cypress::Json	read_config (const std::string &name, const std::string &backend)
bool	check_json_for_parameters (const std::vector< std::string > &parameters, const cypress::Json &json, const std::string name)
cypress::Json	extract_backend (const cypress::Json &config, const std::string &backend)
template<typename T >
std::vector< T >	json_array_to_vector (const cypress::Json &json)
template<typename T , int n>
std::array< T, n >	json_array_to_array (const cypress::Json &json)
template<typename T >
std::vector< std::vector< T > >	json_2Darray_to_vector (const cypress::Json &json)
template<typename T , int n>
std::vector< std::vector< std::array< T, n > > >	json_3Darray_to_vector (const cypress::Json &json)
bool	replace_arrays_by_value (cypress::Json &json, const size_t &index=0, std::string name="", bool warn=true)

Function Documentation

bool SNAB::check_json_for_parameters	(	const std::vector< std::string > &	parameters,
		const cypress::Json &	json,
		const std::string	name
	)

cypress::Json SNAB::extract_backend	(	const cypress::Json &	config,
		const std::string &	backend
	)

Extract backend specific part from a configuration file. Checks for dot seperated backends

template<typename T >

std::vector<std::vector<T> > SNAB::json_2Darray_to_vector

(

const cypress::Json &

json

)

Function to convert a two dimensional array to a vector.

Parameters

json	2D array to be converted. This should not be an object!

Returns

Vector of vectors of type T containing values of the 2D array

Definition at line 150 of file read_json.hpp.

{
    if (!json.is_array() || !json[0].is_array()) {
        throw std::invalid_argument("Error in conversion from Json to array!");
    }
    std::vector<std::vector<T>> res;
    for (auto i : json) {
        res.push_back(json_array_to_vector<T>(i));
    }
    return res;
}

template<typename T , int n>

std::vector<std::vector<std::array<T, n> > > SNAB::json_3Darray_to_vector

(

const cypress::Json &

json

)

Function to convert a three dimensional array to a vector.

Parameters

json	3D array to be converted. This should not be an object!

Returns

Vector of vectors of type T containing values of the 2D array

Definition at line 168 of file read_json.hpp.

{
    if (!json.is_array() || !json[0].is_array()) {
        throw std::invalid_argument("Error in conversion from Json to array!");
    }
    std::vector<std::vector<std::array<T, n>>> res;
    for (size_t i = 0; i< json.size(); i++) {
        std::vector<std::array<T, n>> res2;
        for (size_t j = 0; j< json[i].size(); j++) {
            res2.push_back(json_array_to_array<T, n>(json[i][j]));
        }
        res.push_back(res2);
    }
    return res;
}

template<typename T , int n>

std::array<T, n> SNAB::json_array_to_array

(

const cypress::Json &

json

)

Function to convert a JSON array to a array. This is used for one dimensional arrays only!

Parameters

json	array to be converted. This should not be an object!

Returns

Vector of type T containing values of the array

Definition at line 125 of file read_json.hpp.

{
    if (!json.is_array() || json.size() == 0 || json[0].is_array()) {
        throw std::invalid_argument("Error in conversion from Json to array!");
    }
    std::array<T, n>  res;
    size_t index = 0;
    for (auto i : json) {
        if (i.is_null()) {
            res[index] = std::numeric_limits<T>::quiet_NaN();
        }
        else {
            res[index] = T(i);
        }
        index ++;
    }
    return res;
}

template<typename T >

std::vector<T> SNAB::json_array_to_vector

(

const cypress::Json &

json

)

Function to convert a JSON array to a vector. This is used for one dimensional arrays only!

Parameters

json	array to be converted. This shouold not be an object!

Returns

Vector of type T containing values of the array

Definition at line 101 of file read_json.hpp.

{
    if (!json.is_array() || json.size() == 0 || json[0].is_array()) {
        throw std::invalid_argument("Error in conversion from Json to array!");
    }
    std::vector<T> res;
    for (auto i : json) {
        if (i.is_null()) {
            res.push_back(std::numeric_limits<T>::quiet_NaN());
        }
        else {
            res.push_back(T(i));
        }
    }
    return res;
}

template<typename T >

std::map<std::string, T> SNAB::json_to_map

(

const cypress::Json &

obj

)

Store input form json in a map to check everything!

Definition at line 38 of file read_json.hpp.

{
    std::map<std::string, T> input;
    for (auto i = obj.begin(); i != obj.end(); i++) {
        const cypress::Json value = i.value();
        // Suppress entries like Neuron_Type and sub-lists
        if (value.is_number()) {
            input.emplace(i.key(), value);
        }
    }
    return input;
}

cypress::Real SNAB::NaN

(

)

Used to indicate bad or invalid results.

template<typename T >

std::vector<T> SNAB::read_check	(	std::map< std::string, T > &	input,
		const std::vector< std::string > &	names,
		const std::vector< T > &	defaults
	)

Checks if all values given are needed, terminate if not. If a needed value is not given, take default value and warn user

Definition at line 56 of file read_json.hpp.

{
    std::vector<T> res(names.size());
    for (size_t i = 0; i < res.size(); i++) {
        auto it = input.find(names[i]);
        if (it != input.end()) {
            res[i] = it->second;
            input.erase(it);
        }
        else {
            res[i] = defaults.at(i);
            global_logger().debug("SNABSuite",
                                  "For " + names[i] + " the default value " +
                                      std::to_string(defaults[i]) + " is used");
        }
    }
    for (auto elem : input) {
        throw std::invalid_argument("Unknown parameter \"" + elem.first + "\"");
    }

    return res;
}

cypress::Json SNAB::read_config	(	const std::string &	name,
		const std::string &	backend
	)

bool SNAB::replace_arrays_by_value	(	cypress::Json &	json,
		const size_t &	index = 0,
		std::string	name = "",
		bool	warn = true
	)

Replaces all arrays in a json object with one entry of the same array

Parameters

json	object to be manipulated
index	index of value used
warn	When set to true, warning is given when nothing has been replaced

Returns

true if json was changed

std::vector<std::shared_ptr<SNABBase> > SNAB::snab_registry	(	std::string	backend,
		size_t	bench_index
	)

A vector containing all SNABs/benchmarks which should be executed. The shared pointer ensures that objects live 'long enough'