Softmax Class Reference

A class that implements the Softmax activation function, inheriting from MLFunction. More...

#include <functions.h>

Inheritance diagram for Softmax:

Public Member Functions
	Softmax ()
	Default constructor.
void	apply (const SelectivityVector &rows, std::vector< VectorPtr > &args, const TypePtr &type, exec::EvalCtx &context, VectorPtr &output) const override
	Applies the Softmax function to the input array.
float *	getTensor () const override
	Returns the tensor associated with this function.
std::string	getFuncName ()
	Returns the name of the function.
CostEstimate	getCost (std::vector< int > inputDims)
	Estimates the computational cost of applying the Softmax function.
Public Member Functions inherited from MLFunction
virtual	~MLFunction ()=default
	Virtual destructor.
virtual std::vector< int >	getDims ()
	Returns the dimensions of the function.
virtual int	getNumDims ()
	Returns the number of dimensions of the function.

Static Public Member Functions
static std::vector< std::shared_ptr< exec::FunctionSignature > >	signatures ()
	Returns the function signatures supported by this class.
static std::string	getName ()
	Static method to return the name of the function.

Additional Inherited Members
Protected Member Functions inherited from MLFunction
double	getWeightedCost (std::string name, float cost)
	Calculates the weighted cost of the function.
std::vector< double >	getCoefficientVector (std::string name)
	Retrieves the cost coefficients for the function.
Protected Attributes inherited from MLFunction
std::vector< int >	dims
	Dimensions of the function.

Detailed Description

A class that implements the Softmax activation function, inheriting from MLFunction.

The Softmax function converts a vector of values into a probability distribution, where the values sum to 1. This class provides functionality to apply the Softmax function to an input array and produce an output array.

Member Function Documentation

apply()

void Softmax::apply ( const SelectivityVector & rows, std::vector< VectorPtr > & args, const TypePtr & type, exec::EvalCtx & context, VectorPtr & output ) const

inlineoverride

Applies the Softmax function to the input array.

This method processes the input array, applies the Softmax function, and stores the result in the output vector.

Parameters

rows	A SelectivityVector specifying the rows to process.
args	A vector of input arguments (e.g., the input array).
type	The type of the output vector.
context	The execution context.
output	The output vector where the result will be stored.

getCost()

CostEstimate Softmax::getCost ( std::vector< int > inputDims )

inlinevirtual

Estimates the computational cost of applying the Softmax function.

Parameters

inputDims

A vector containing the dimensions of the input.

Returns

A CostEstimate object representing the estimated cost.

Reimplemented from MLFunction.

getFuncName()

std::string Softmax::getFuncName ( )

inlinevirtual

Returns the name of the function.

Returns

The name of the function as a string.

Reimplemented from MLFunction.

getName()

static std::string Softmax::getName ( )

inlinestatic

Static method to return the name of the function.

Returns

The name of the function as a string ("softmax").

getTensor()

float * Softmax::getTensor ( ) const

inlineoverridevirtual

Returns the tensor associated with this function.

Returns

A pointer to an empty float array (no weights for Softmax).

Implements MLFunction.

signatures()

static std::vector< std::shared_ptr< exec::FunctionSignature > > Softmax::signatures ( )

inlinestatic

Returns the function signatures supported by this class.

Returns

A vector of shared pointers to FunctionSignature objects.

---

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

• functions.h