Operators and Keywords

C++ API

# conv2.cc File Reference

`#include "oct-convn.h"`
`#include "defun-dld.h"`
`#include "error.h"`
`#include "oct-obj.h"`
`#include "utils.h"`
Include dependency graph for conv2.cc: ## Enumerations

enum  Shape { SHAPE_FULL, SHAPE_SAME, SHAPE_VALID }

## Functions

DEFUN_DLD (conv2, args,,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} conv2 (@var{A}, @var{B})\n\ @deftypefnx {Loadable Function} {} conv2 (@var{v1}, @var{v2}, @var{m})\n\ @deftypefnx {Loadable Function} {} conv2 (@dots{}, @var{shape})\n\ Return the 2-D convolution of @var{A} and @var{B}. The size of the result\n\ is determined by the optional @var{shape} argument which takes the following\n\ values\n\ \n\ @table @asis\n\ @item @var{shape} = \"full\"\n\ Return the full convolution. (default)\n\ \n\ @item @var{shape} = \"same\"\n\ Return the central part of the convolution with the same size as @var{A}.\n\ \n\ @item @var{shape} = \"valid\"\n\ Return only the parts which do not include zero-padded edges.\n\ @end table\n\ \n\ When the third argument is a matrix, return the convolution of the matrix\n\ @var{m} by the vector @var{v1} in the column direction and by the vector\n\ @var{v2} in the row direction\n\ @seealso{conv, convn}\n\ @end deftypefn")
DEFUN_DLD (convn, args,,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{C} =} convn (@var{A}, @var{B}, @var{shape})\n\ Return the n-D convolution of @var{A} and @var{B} where the size\n\ of @var{C} is given by\n\ \n\ @table @asis\n\ @item @var{shape} = \"full\"\n\ Return the full convolution.\n\ \n\ @item @var{shape} = \"same\"\n\ Return central part of the convolution with the same size as @var{A}.\n\ \n\ @item @var{shape} = \"valid\"\n\ Return only the parts which do not include zero-padded edges.\n\ @end table\n\ \n\ By default @var{shape} is @samp{\"full\"}.\n\ @seealso{conv2, conv}\n\ @end deftypefn")

## Enumeration Type Documentation

 enum Shape
Enumerator:
 SHAPE_FULL SHAPE_SAME SHAPE_VALID

## Function Documentation

 DEFUN_DLD ( conv2 , args )
 DEFUN_DLD ( convn , args )