ML functions
 
Loading...
Searching...
No Matches
MaxPool Class Reference

A class that implements max pooling, inheriting from MLFunction. More...

#include <functions.h>

Inheritance diagram for MaxPool:
MLFunction

Public Member Functions

 MaxPool (int side, int rows, int cols)
 Constructor that initializes the max pooling operation with dimensions.
 
void apply (const SelectivityVector &rows, std::vector< VectorPtr > &args, const TypePtr &type, exec::EvalCtx &context, VectorPtr &output) const override
 Applies max pooling to the input array.
 
float * getTensor () const override
 Returns the tensor associated with this function.
 
std::string getFuncName ()
 Returns the name of the 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.
 
virtual CostEstimate getCost (std::vector< int > inputDims)
 Estimates the computational cost of applying 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 max pooling, inheriting from MLFunction.

This class provides functionality to apply max pooling to an input array.

Constructor & Destructor Documentation

◆ MaxPool()

MaxPool::MaxPool ( int side,
int rows,
int cols )
inline

Constructor that initializes the max pooling operation with dimensions.

Parameters
sideThe size of the pooling window.
rowsThe number of rows in the input.
colsThe number of columns in the input.

Member Function Documentation

◆ apply()

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

Applies max pooling to the input array.

This method processes the input array, applies max pooling, and stores the result in the output vector.

Parameters
rowsA SelectivityVector specifying the rows to process.
argsA vector of input arguments (e.g., the input array).
typeThe type of the output vector.
contextThe execution context.
outputThe output vector where the result will be stored.

◆ getFuncName()

std::string MaxPool::getFuncName ( )
inlinevirtual

Returns the name of the function.

Returns
The name of the function as a string.

Reimplemented from MLFunction.

◆ getName()

static std::string MaxPool::getName ( )
inlinestatic

Static method to return the name of the function.

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

◆ getTensor()

float * MaxPool::getTensor ( ) const
inlineoverridevirtual

Returns the tensor associated with this function.

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

Implements MLFunction.

◆ signatures()

static std::vector< std::shared_ptr< exec::FunctionSignature > > MaxPool::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: