serif::network::Network Class Reference

Class for network evaluation. More...

#include <network.h>

Inheritance diagram for serif::network::Network:

Public Member Functions
	Network (const NetworkFormat format=NetworkFormat::APPROX8)
virtual	~Network ()=default
NetworkFormat	getFormat () const
NetworkFormat	setFormat (const NetworkFormat format)
virtual NetOut	evaluate (const NetIn &netIn)
	Evaluate the network based on the input parameters.
virtual bool	isStiff () const
virtual void	setStiff (const bool stiff)

Protected Attributes
serif::config::Config &	m_config
	Configuration instance.
serif::probe::LogManager &	m_logManager
	Log manager instance.
quill::Logger *	m_logger
	Logger instance.
NetworkFormat	m_format
	Format of the network.
serif::constant::Constants &	m_constants
bool	m_stiff = false
	Flag indicating if the network is stiff.

Detailed Description

Class for network evaluation.

This class provides methods to evaluate the network based on the input parameters.

Example usage:

nuclearNetwork::Network network;
nuclearNetwork::NetIn netIn;
// Set netIn parameters...
nuclearNetwork::NetOut netOut = network.evaluate(netIn);

Definition at line 114 of file network.h.

Constructor & Destructor Documentation

Network()

serif::network::Network::Network ( const NetworkFormat format = NetworkFormat::APPROX8 )

explicit

Definition at line 32 of file network.cpp.

~Network()

virtual serif::network::Network::~Network ( )

virtualdefault

Member Function Documentation

evaluate()

NetOut serif::network::Network::evaluate ( const NetIn & netIn )

virtual

Evaluate the network based on the input parameters.

Parameters

netIn

Input parameters for the network evaluation.

Returns

NetOut Output results from the network evaluation.

Reimplemented in serif::network::approx8::Approx8Network, serif::network::GraphNetwork, and serif::network::ReaclibNetwork.

Definition at line 54 of file network.cpp.

getFormat()

NetworkFormat serif::network::Network::getFormat ( ) const

nodiscard

Definition at line 44 of file network.cpp.

isStiff()

virtual bool serif::network::Network::isStiff ( ) const

inlinevirtual

Reimplemented in serif::network::approx8::Approx8Network.

Definition at line 130 of file network.h.

setFormat()

NetworkFormat serif::network::Network::setFormat

(

const NetworkFormat

format

)

Definition at line 48 of file network.cpp.

setStiff()

virtual void serif::network::Network::setStiff ( const bool stiff )

inlinevirtual

Reimplemented in serif::network::approx8::Approx8Network.

Definition at line 131 of file network.h.

Member Data Documentation

m_config

serif::config::Config& serif::network::Network::m_config

protected

Configuration instance.

Definition at line 134 of file network.h.

m_constants

serif::constant::Constants& serif::network::Network::m_constants

protected

Definition at line 139 of file network.h.

m_format

NetworkFormat serif::network::Network::m_format

protected

Format of the network.

Definition at line 138 of file network.h.

m_logger

quill::Logger* serif::network::Network::m_logger

protected

Logger instance.

Definition at line 136 of file network.h.

m_logManager

serif::probe::LogManager& serif::network::Network::m_logManager

protected

Log manager instance.

Definition at line 135 of file network.h.

m_stiff

bool serif::network::Network::m_stiff = false

protected

Flag indicating if the network is stiff.

Definition at line 141 of file network.h.

---

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

• src/network/public/network.h
• src/network/private/network.cpp