libdspl-2.0/dspl/src/array/sum.c

/*
* Copyright (c) 2015-2024 Sergey Bakhurin
* Digital Signal Processing Library [http://dsplib.org]
*
* This file is part of libdspl-2.0.
*
* is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser    General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* DSPL is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Foobar.    If not, see <http://www.gnu.org/licenses/>.
*/


#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "dspl.h"


#ifdef DOXYGEN_ENGLISH
/*! ****************************************************************************
\ingroup ARRAY_GROUP     

\author Sergey Bakhurin www.dsplib.org
***************************************************************************** */
#endif
#ifdef DOXYGEN_RUSSIAN
/*! ****************************************************************************
\ingroup ARRAY_GROUP
\brief Расчет суммы элеметов массива

\param[in] x
Указатель на вещественный вектор `x`. \n
Размер вектора `[n x 1]`. \n    
\n

\param[in] n
Размер вектора `x`. \n
\n

\param[in] n
Указатель на переменную суммы элементов массива. \n
По данному указателю будет записан результат работы функции.
\n


\return
`RES_OK` если функция выполнена успешно. \n
В противном случае \ref ERROR_CODE_GROUP "код ошибки".

Пример:
\code{.cpp}
double y[5] = {0.0, 1.0, 2.0, 3.0, 4.0};
double s;
sum(y, 5, &s);
printf("s = %6.1f% \n", s);
\endcode
 \n
Результат выполнения:
\verbatim
    s = 10
\endverbatim

\author Бахурин Сергей www.dsplib.org
***************************************************************************** */
#endif
int DSPL_API sum(double* x, int n, double* s)
{
    int i;
    double z = 0.0;
    if(!x || !s)
        return ERROR_PTR;
    if(n<1)
        return ERROR_SIZE;
      
    for(i = 0; i < n; i++)
        z += x[i];
    *s = z;
    return RES_OK;
}
-												New Structure is beginning
 Changes to be committed:
	deleted:    _release/.gitignore
	deleted:    _release/Makefile
	modified:   _release/dspl.c
	modified:   _release/dspl.h
	deleted:    _release/test.c
	modified:   dspl/Makefile
	modified:   dspl/src/array.c
	new file:   dspl/src/array/array_scale_lin.c
	new file:   dspl/src/array/concat.c
	new file:   dspl/src/array/decimate.c
	new file:   dspl/src/array/decimate_cmplx.c
	new file:   dspl/src/array/find_nearest.c
	new file:   dspl/src/array/flipip.c
	new file:   dspl/src/array/flipip_cmplx.c
	new file:   dspl/src/array/linspace.c
	new file:   dspl/src/array/logspace.c
	new file:   dspl/src/array/ones.c
	new file:   dspl/src/array/sum.c
	new file:   dspl/src/array/sum_sqr.c
	modified:   dspl/src/dft.c
	new file:   dspl/src/dft/dft.c
	new file:   dspl/src/dft/dft_cmplx.c
	new file:   dspl/src/dft/fft.c
	new file:   dspl/src/dft/fft_abs.c
	new file:   dspl/src/dft/fft_abs_cmplx.c
	new file:   dspl/src/dft/fft_cmplx.c
	new file:   dspl/src/dft/fft_create.c
	new file:   dspl/src/dft/fft_free.c
	new file:   dspl/src/dft/fft_krn.c
	new file:   dspl/src/dft/fft_mag.c
	new file:   dspl/src/dft/fft_mag_cmplx.c
	new file:   dspl/src/dft/fft_shift.c
	new file:   dspl/src/dft/fft_shift_cmplx.c
	renamed:    dspl/src/fft_subkernel.c -> dspl/src/dft/fft_subkernel.c
	new file:   dspl/src/dft/fourier_integral_cmplx.c
	new file:   dspl/src/dft/fourier_series_dec.c
	new file:   dspl/src/dft/fourier_series_dec_cmplx.c
	new file:   dspl/src/dft/fourier_series_rec.c
	new file:   dspl/src/dft/goertzel.c
	renamed:    dspl/src/goertzel.c -> dspl/src/dft/goertzel_cmplx.c
	new file:   dspl/src/dft/idft_cmplx.c
	new file:   dspl/src/dft/ifft_cmplx.c
	deleted:    dspl/src/fft.c
	deleted:    dspl/src/fourier_series.c
	new file:   dspl/src/math_poly.c
	new file:   dspl/src/math_poly/cheby_poly1.c
	renamed:    dspl/src/cheby.c -> dspl/src/math_poly/cheby_poly2.c
	new file:   dspl/src/math_poly/poly_z2a_cmplx.c
	renamed:    dspl/src/polyval.c -> dspl/src/math_poly/polyroots.c
	new file:   dspl/src/math_poly/polyval.c
	new file:   dspl/src/math_poly/polyval_cmplx.c
	modified:   make.inc

											
										
										
											2021-12-29 11:33:52 +00:00
+								/*
-												 Changes to be committed:
	modified:   src/array/array_scale_lin.c
	modified:   src/array/concat.c
	modified:   src/array/decimate.c
	modified:   src/array/decimate_cmplx.c
	modified:   src/array/find_nearest.c
	modified:   src/array/flipip.c
	modified:   src/array/flipip_cmplx.c
	modified:   src/array/linspace.c
	modified:   src/array/logspace.c
	modified:   src/array/ones.c
	modified:   src/array/sum.c
	modified:   src/array/sum_sqr.c
	modified:   src/array/verif.c
	modified:   src/array/verif_cmplx.c
	modified:   src/convolution/conv.c
	modified:   src/convolution/conv_cmplx.c
	modified:   src/convolution/conv_fft.c
	modified:   src/convolution/conv_fft_cmplx.c
	modified:   src/convolution/filter_iir.c
	modified:   src/dft/dft.c
	modified:   src/dft/dft_cmplx.c
	modified:   src/dft/fft.c
	modified:   src/dft/fft_abs.c
	modified:   src/dft/fft_abs_cmplx.c
	modified:   src/dft/fft_cmplx.c
	modified:   src/dft/fft_create.c
	modified:   src/dft/fft_free.c
	modified:   src/dft/fft_krn.c
	modified:   src/dft/fft_mag.c
	modified:   src/dft/fft_mag_cmplx.c
	modified:   src/dft/fft_shift.c
	modified:   src/dft/fft_shift_cmplx.c
	modified:   src/dft/fft_subkernel.c
	modified:   src/dft/fourier_integral_cmplx.c
	modified:   src/dft/fourier_series_dec.c
	modified:   src/dft/fourier_series_dec_cmplx.c
	modified:   src/dft/fourier_series_rec.c
	modified:   src/dft/goertzel.c
	modified:   src/dft/goertzel_cmplx.c
	modified:   src/dft/idft_cmplx.c
	modified:   src/dft/ifft_cmplx.c

											
										
										
											2023-12-11 20:08:57 +00:00
+								* Copyright (c) 2015-2024 Sergey Bakhurin
-												New Structure is beginning
 Changes to be committed:
	deleted:    _release/.gitignore
	deleted:    _release/Makefile
	modified:   _release/dspl.c
	modified:   _release/dspl.h
	deleted:    _release/test.c
	modified:   dspl/Makefile
	modified:   dspl/src/array.c
	new file:   dspl/src/array/array_scale_lin.c
	new file:   dspl/src/array/concat.c
	new file:   dspl/src/array/decimate.c
	new file:   dspl/src/array/decimate_cmplx.c
	new file:   dspl/src/array/find_nearest.c
	new file:   dspl/src/array/flipip.c
	new file:   dspl/src/array/flipip_cmplx.c
	new file:   dspl/src/array/linspace.c
	new file:   dspl/src/array/logspace.c
	new file:   dspl/src/array/ones.c
	new file:   dspl/src/array/sum.c
	new file:   dspl/src/array/sum_sqr.c
	modified:   dspl/src/dft.c
	new file:   dspl/src/dft/dft.c
	new file:   dspl/src/dft/dft_cmplx.c
	new file:   dspl/src/dft/fft.c
	new file:   dspl/src/dft/fft_abs.c
	new file:   dspl/src/dft/fft_abs_cmplx.c
	new file:   dspl/src/dft/fft_cmplx.c
	new file:   dspl/src/dft/fft_create.c
	new file:   dspl/src/dft/fft_free.c
	new file:   dspl/src/dft/fft_krn.c
	new file:   dspl/src/dft/fft_mag.c
	new file:   dspl/src/dft/fft_mag_cmplx.c
	new file:   dspl/src/dft/fft_shift.c
	new file:   dspl/src/dft/fft_shift_cmplx.c
	renamed:    dspl/src/fft_subkernel.c -> dspl/src/dft/fft_subkernel.c
	new file:   dspl/src/dft/fourier_integral_cmplx.c
	new file:   dspl/src/dft/fourier_series_dec.c
	new file:   dspl/src/dft/fourier_series_dec_cmplx.c
	new file:   dspl/src/dft/fourier_series_rec.c
	new file:   dspl/src/dft/goertzel.c
	renamed:    dspl/src/goertzel.c -> dspl/src/dft/goertzel_cmplx.c
	new file:   dspl/src/dft/idft_cmplx.c
	new file:   dspl/src/dft/ifft_cmplx.c
	deleted:    dspl/src/fft.c
	deleted:    dspl/src/fourier_series.c
	new file:   dspl/src/math_poly.c
	new file:   dspl/src/math_poly/cheby_poly1.c
	renamed:    dspl/src/cheby.c -> dspl/src/math_poly/cheby_poly2.c
	new file:   dspl/src/math_poly/poly_z2a_cmplx.c
	renamed:    dspl/src/polyval.c -> dspl/src/math_poly/polyroots.c
	new file:   dspl/src/math_poly/polyval.c
	new file:   dspl/src/math_poly/polyval_cmplx.c
	modified:   make.inc

											
										
										
											2021-12-29 11:33:52 +00:00
+								* Digital Signal Processing Library [http://dsplib.org]
 								*
 								* This file is part of libdspl-2.0.
 								*
 								* is free software: you can redistribute it and/or modify
 								* it under the terms of the GNU Lesser    General Public License as published by
 								* the Free Software Foundation, either version 3 of the License, or
 								* (at your option) any later version.
 								*
 								* DSPL is distributed in the hope that it will be useful,
 								* but WITHOUT ANY WARRANTY; without even the implied warranty of
 								* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
 								* GNU General Public License for more details.
 								*
 								* You should have received a copy of the GNU Lesser General Public License
 								* along with Foobar.    If not, see <http://www.gnu.org/licenses/>.
 								*/
 								#include <stdio.h>
 								#include <stdlib.h>
 								#include <string.h>
 								#include "dspl.h"
 								#ifdef DOXYGEN_ENGLISH
 								/*! ****************************************************************************
-												 Changes to be committed:
	modified:   src/array/array_scale_lin.c
	modified:   src/array/concat.c
	modified:   src/array/decimate.c
	modified:   src/array/decimate_cmplx.c
	modified:   src/array/find_nearest.c
	modified:   src/array/flipip.c
	modified:   src/array/flipip_cmplx.c
	modified:   src/array/linspace.c
	modified:   src/array/logspace.c
	modified:   src/array/ones.c
	modified:   src/array/sum.c
	modified:   src/array/sum_sqr.c
	modified:   src/array/verif.c
	modified:   src/array/verif_cmplx.c
	modified:   src/convolution/conv.c
	modified:   src/convolution/conv_cmplx.c
	modified:   src/convolution/conv_fft.c
	modified:   src/convolution/conv_fft_cmplx.c
	modified:   src/convolution/filter_iir.c
	modified:   src/dft/dft.c
	modified:   src/dft/dft_cmplx.c
	modified:   src/dft/fft.c
	modified:   src/dft/fft_abs.c
	modified:   src/dft/fft_abs_cmplx.c
	modified:   src/dft/fft_cmplx.c
	modified:   src/dft/fft_create.c
	modified:   src/dft/fft_free.c
	modified:   src/dft/fft_krn.c
	modified:   src/dft/fft_mag.c
	modified:   src/dft/fft_mag_cmplx.c
	modified:   src/dft/fft_shift.c
	modified:   src/dft/fft_shift_cmplx.c
	modified:   src/dft/fft_subkernel.c
	modified:   src/dft/fourier_integral_cmplx.c
	modified:   src/dft/fourier_series_dec.c
	modified:   src/dft/fourier_series_dec_cmplx.c
	modified:   src/dft/fourier_series_rec.c
	modified:   src/dft/goertzel.c
	modified:   src/dft/goertzel_cmplx.c
	modified:   src/dft/idft_cmplx.c
	modified:   src/dft/ifft_cmplx.c

											
										
										
											2023-12-11 20:08:57 +00:00
+								\ingroup ARRAY_GROUP
-												New Structure is beginning
 Changes to be committed:
	deleted:    _release/.gitignore
	deleted:    _release/Makefile
	modified:   _release/dspl.c
	modified:   _release/dspl.h
	deleted:    _release/test.c
	modified:   dspl/Makefile
	modified:   dspl/src/array.c
	new file:   dspl/src/array/array_scale_lin.c
	new file:   dspl/src/array/concat.c
	new file:   dspl/src/array/decimate.c
	new file:   dspl/src/array/decimate_cmplx.c
	new file:   dspl/src/array/find_nearest.c
	new file:   dspl/src/array/flipip.c
	new file:   dspl/src/array/flipip_cmplx.c
	new file:   dspl/src/array/linspace.c
	new file:   dspl/src/array/logspace.c
	new file:   dspl/src/array/ones.c
	new file:   dspl/src/array/sum.c
	new file:   dspl/src/array/sum_sqr.c
	modified:   dspl/src/dft.c
	new file:   dspl/src/dft/dft.c
	new file:   dspl/src/dft/dft_cmplx.c
	new file:   dspl/src/dft/fft.c
	new file:   dspl/src/dft/fft_abs.c
	new file:   dspl/src/dft/fft_abs_cmplx.c
	new file:   dspl/src/dft/fft_cmplx.c
	new file:   dspl/src/dft/fft_create.c
	new file:   dspl/src/dft/fft_free.c
	new file:   dspl/src/dft/fft_krn.c
	new file:   dspl/src/dft/fft_mag.c
	new file:   dspl/src/dft/fft_mag_cmplx.c
	new file:   dspl/src/dft/fft_shift.c
	new file:   dspl/src/dft/fft_shift_cmplx.c
	renamed:    dspl/src/fft_subkernel.c -> dspl/src/dft/fft_subkernel.c
	new file:   dspl/src/dft/fourier_integral_cmplx.c
	new file:   dspl/src/dft/fourier_series_dec.c
	new file:   dspl/src/dft/fourier_series_dec_cmplx.c
	new file:   dspl/src/dft/fourier_series_rec.c
	new file:   dspl/src/dft/goertzel.c
	renamed:    dspl/src/goertzel.c -> dspl/src/dft/goertzel_cmplx.c
	new file:   dspl/src/dft/idft_cmplx.c
	new file:   dspl/src/dft/ifft_cmplx.c
	deleted:    dspl/src/fft.c
	deleted:    dspl/src/fourier_series.c
	new file:   dspl/src/math_poly.c
	new file:   dspl/src/math_poly/cheby_poly1.c
	renamed:    dspl/src/cheby.c -> dspl/src/math_poly/cheby_poly2.c
	new file:   dspl/src/math_poly/poly_z2a_cmplx.c
	renamed:    dspl/src/polyval.c -> dspl/src/math_poly/polyroots.c
	new file:   dspl/src/math_poly/polyval.c
	new file:   dspl/src/math_poly/polyval_cmplx.c
	modified:   make.inc

											
										
										
											2021-12-29 11:33:52 +00:00
+								\author Sergey Bakhurin www.dsplib.org
 								***************************************************************************** */
 								#endif
 								#ifdef DOXYGEN_RUSSIAN
 								/*! ****************************************************************************
 								\ingroup ARRAY_GROUP
-												 Changes to be committed:
	modified:   src/array/array_scale_lin.c
	modified:   src/array/concat.c
	modified:   src/array/decimate.c
	modified:   src/array/decimate_cmplx.c
	modified:   src/array/find_nearest.c
	modified:   src/array/flipip.c
	modified:   src/array/flipip_cmplx.c
	modified:   src/array/linspace.c
	modified:   src/array/logspace.c
	modified:   src/array/ones.c
	modified:   src/array/sum.c
	modified:   src/array/sum_sqr.c
	modified:   src/array/verif.c
	modified:   src/array/verif_cmplx.c
	modified:   src/convolution/conv.c
	modified:   src/convolution/conv_cmplx.c
	modified:   src/convolution/conv_fft.c
	modified:   src/convolution/conv_fft_cmplx.c
	modified:   src/convolution/filter_iir.c
	modified:   src/dft/dft.c
	modified:   src/dft/dft_cmplx.c
	modified:   src/dft/fft.c
	modified:   src/dft/fft_abs.c
	modified:   src/dft/fft_abs_cmplx.c
	modified:   src/dft/fft_cmplx.c
	modified:   src/dft/fft_create.c
	modified:   src/dft/fft_free.c
	modified:   src/dft/fft_krn.c
	modified:   src/dft/fft_mag.c
	modified:   src/dft/fft_mag_cmplx.c
	modified:   src/dft/fft_shift.c
	modified:   src/dft/fft_shift_cmplx.c
	modified:   src/dft/fft_subkernel.c
	modified:   src/dft/fourier_integral_cmplx.c
	modified:   src/dft/fourier_series_dec.c
	modified:   src/dft/fourier_series_dec_cmplx.c
	modified:   src/dft/fourier_series_rec.c
	modified:   src/dft/goertzel.c
	modified:   src/dft/goertzel_cmplx.c
	modified:   src/dft/idft_cmplx.c
	modified:   src/dft/ifft_cmplx.c

											
										
										
											2023-12-11 20:08:57 +00:00
+								\brief Расчет суммы элеметов массива
 								\param[in] x
 								Указатель на вещественный вектор `x`. \n
 								Размер вектора `[n x 1]`. \n
 								\n
 								\param[in] n
 								Размер вектора `x`. \n
 								\n
 								\param[in] n
 								Указатель на переменную суммы элементов массива. \n
 								По данному указателю будет записан результат работы функции.
 								\n
 								\return
 								`RES_OK` если функция выполнена успешно. \n
 								В противном случае \ref ERROR_CODE_GROUP "код ошибки".
 								Пример:
 								\code{.cpp}
 								double y[5] = {0.0, 1.0, 2.0, 3.0, 4.0};
 								double s;
 								sum(y, 5, &s);
 								printf("s = %6.1f% \n", s);
 								\endcode
 								 \n
 								Результат выполнения:
 								\verbatim
 								    s = 10
 								\endverbatim
-												New Structure is beginning
 Changes to be committed:
	deleted:    _release/.gitignore
	deleted:    _release/Makefile
	modified:   _release/dspl.c
	modified:   _release/dspl.h
	deleted:    _release/test.c
	modified:   dspl/Makefile
	modified:   dspl/src/array.c
	new file:   dspl/src/array/array_scale_lin.c
	new file:   dspl/src/array/concat.c
	new file:   dspl/src/array/decimate.c
	new file:   dspl/src/array/decimate_cmplx.c
	new file:   dspl/src/array/find_nearest.c
	new file:   dspl/src/array/flipip.c
	new file:   dspl/src/array/flipip_cmplx.c
	new file:   dspl/src/array/linspace.c
	new file:   dspl/src/array/logspace.c
	new file:   dspl/src/array/ones.c
	new file:   dspl/src/array/sum.c
	new file:   dspl/src/array/sum_sqr.c
	modified:   dspl/src/dft.c
	new file:   dspl/src/dft/dft.c
	new file:   dspl/src/dft/dft_cmplx.c
	new file:   dspl/src/dft/fft.c
	new file:   dspl/src/dft/fft_abs.c
	new file:   dspl/src/dft/fft_abs_cmplx.c
	new file:   dspl/src/dft/fft_cmplx.c
	new file:   dspl/src/dft/fft_create.c
	new file:   dspl/src/dft/fft_free.c
	new file:   dspl/src/dft/fft_krn.c
	new file:   dspl/src/dft/fft_mag.c
	new file:   dspl/src/dft/fft_mag_cmplx.c
	new file:   dspl/src/dft/fft_shift.c
	new file:   dspl/src/dft/fft_shift_cmplx.c
	renamed:    dspl/src/fft_subkernel.c -> dspl/src/dft/fft_subkernel.c
	new file:   dspl/src/dft/fourier_integral_cmplx.c
	new file:   dspl/src/dft/fourier_series_dec.c
	new file:   dspl/src/dft/fourier_series_dec_cmplx.c
	new file:   dspl/src/dft/fourier_series_rec.c
	new file:   dspl/src/dft/goertzel.c
	renamed:    dspl/src/goertzel.c -> dspl/src/dft/goertzel_cmplx.c
	new file:   dspl/src/dft/idft_cmplx.c
	new file:   dspl/src/dft/ifft_cmplx.c
	deleted:    dspl/src/fft.c
	deleted:    dspl/src/fourier_series.c
	new file:   dspl/src/math_poly.c
	new file:   dspl/src/math_poly/cheby_poly1.c
	renamed:    dspl/src/cheby.c -> dspl/src/math_poly/cheby_poly2.c
	new file:   dspl/src/math_poly/poly_z2a_cmplx.c
	renamed:    dspl/src/polyval.c -> dspl/src/math_poly/polyroots.c
	new file:   dspl/src/math_poly/polyval.c
	new file:   dspl/src/math_poly/polyval_cmplx.c
	modified:   make.inc

											
										
										
											2021-12-29 11:33:52 +00:00
+								\author Бахурин Сергей www.dsplib.org
 								***************************************************************************** */
 								#endif
 								int DSPL_API sum(double* x, int n, double* s)
 								{
 								    int i;
 								    double z = 0.0;
 								    if(!x || !s)
 								        return ERROR_PTR;
 								    if(n<1)
 								        return ERROR_SIZE;
 								    for(i = 0; i < n; i++)
 								        z += x[i];
 								    *s = z;
 								    return RES_OK;
 								}