Chris@82: /*
Chris@82:  * Copyright (c) 2003, 2007-14 Matteo Frigo
Chris@82:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
Chris@82:  *
Chris@82:  * This program is free software; you can redistribute it and/or modify
Chris@82:  * it under the terms of the GNU General Public License as published by
Chris@82:  * the Free Software Foundation; either version 2 of the License, or
Chris@82:  * (at your option) any later version.
Chris@82:  *
Chris@82:  * This program is distributed in the hope that it will be useful,
Chris@82:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@82:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@82:  * GNU General Public License for more details.
Chris@82:  *
Chris@82:  * You should have received a copy of the GNU General Public License
Chris@82:  * along with this program; if not, write to the Free Software
Chris@82:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Chris@82:  *
Chris@82:  */
Chris@82: 
Chris@82: 
Chris@82: 
Chris@82: /* solvers/plans for vectors of small DFT's that cannot be done
Chris@82:    in-place directly.  Use a rank-0 plan to rearrange the data
Chris@82:    before or after the transform.  Can also change an out-of-place
Chris@82:    plan into a copy + in-place (where the in-place transform
Chris@82:    is e.g. unit stride). */
Chris@82: 
Chris@82: /* FIXME: merge with rank-geq2.c(?), since this is just a special case
Chris@82:    of a rank split where the first/second transform has rank 0. */
Chris@82: 
Chris@82: #include "dft/dft.h"
Chris@82: 
Chris@82: typedef problem *(*mkcld_t) (const problem_dft *p);
Chris@82: 
Chris@82: typedef struct {
Chris@82:      dftapply apply;
Chris@82:      problem *(*mkcld)(const problem_dft *p);
Chris@82:      const char *nam;
Chris@82: } ndrct_adt;
Chris@82: 
Chris@82: typedef struct {
Chris@82:      solver super;
Chris@82:      const ndrct_adt *adt;
Chris@82: } S;
Chris@82: 
Chris@82: typedef struct {
Chris@82:      plan_dft super;
Chris@82:      plan *cldcpy, *cld;
Chris@82:      const S *slv;
Chris@82: } P;
Chris@82: 
Chris@82: /*-----------------------------------------------------------------------*/
Chris@82: /* first rearrange, then transform */
Chris@82: static void apply_before(const plan *ego_, R *ri, R *ii, R *ro, R *io)
Chris@82: {
Chris@82:      const P *ego = (const P *) ego_;
Chris@82: 
Chris@82:      {
Chris@82:           plan_dft *cldcpy = (plan_dft *) ego->cldcpy;
Chris@82:           cldcpy->apply(ego->cldcpy, ri, ii, ro, io);
Chris@82:      }
Chris@82:      {
Chris@82:           plan_dft *cld = (plan_dft *) ego->cld;
Chris@82:           cld->apply(ego->cld, ro, io, ro, io);
Chris@82:      }
Chris@82: }
Chris@82: 
Chris@82: static problem *mkcld_before(const problem_dft *p)
Chris@82: {
Chris@82:      return X(mkproblem_dft_d)(X(tensor_copy_inplace)(p->sz, INPLACE_OS),
Chris@82: 			       X(tensor_copy_inplace)(p->vecsz, INPLACE_OS),
Chris@82: 			       p->ro, p->io, p->ro, p->io);
Chris@82: }
Chris@82: 
Chris@82: static const ndrct_adt adt_before =
Chris@82: {
Chris@82:      apply_before, mkcld_before, "dft-indirect-before"
Chris@82: };
Chris@82: 
Chris@82: /*-----------------------------------------------------------------------*/
Chris@82: /* first transform, then rearrange */
Chris@82: 
Chris@82: static void apply_after(const plan *ego_, R *ri, R *ii, R *ro, R *io)
Chris@82: {
Chris@82:      const P *ego = (const P *) ego_;
Chris@82: 
Chris@82:      {
Chris@82:           plan_dft *cld = (plan_dft *) ego->cld;
Chris@82:           cld->apply(ego->cld, ri, ii, ri, ii);
Chris@82:      }
Chris@82:      {
Chris@82:           plan_dft *cldcpy = (plan_dft *) ego->cldcpy;
Chris@82:           cldcpy->apply(ego->cldcpy, ri, ii, ro, io);
Chris@82:      }
Chris@82: }
Chris@82: 
Chris@82: static problem *mkcld_after(const problem_dft *p)
Chris@82: {
Chris@82:      return X(mkproblem_dft_d)(X(tensor_copy_inplace)(p->sz, INPLACE_IS),
Chris@82: 			       X(tensor_copy_inplace)(p->vecsz, INPLACE_IS),
Chris@82: 			       p->ri, p->ii, p->ri, p->ii);
Chris@82: }
Chris@82: 
Chris@82: static const ndrct_adt adt_after =
Chris@82: {
Chris@82:      apply_after, mkcld_after, "dft-indirect-after"
Chris@82: };
Chris@82: 
Chris@82: /*-----------------------------------------------------------------------*/
Chris@82: static void destroy(plan *ego_)
Chris@82: {
Chris@82:      P *ego = (P *) ego_;
Chris@82:      X(plan_destroy_internal)(ego->cld);
Chris@82:      X(plan_destroy_internal)(ego->cldcpy);
Chris@82: }
Chris@82: 
Chris@82: static void awake(plan *ego_, enum wakefulness wakefulness)
Chris@82: {
Chris@82:      P *ego = (P *) ego_;
Chris@82:      X(plan_awake)(ego->cldcpy, wakefulness);
Chris@82:      X(plan_awake)(ego->cld, wakefulness);
Chris@82: }
Chris@82: 
Chris@82: static void print(const plan *ego_, printer *p)
Chris@82: {
Chris@82:      const P *ego = (const P *) ego_;
Chris@82:      const S *s = ego->slv;
Chris@82:      p->print(p, "(%s%(%p%)%(%p%))", s->adt->nam, ego->cld, ego->cldcpy);
Chris@82: }
Chris@82: 
Chris@82: static int applicable0(const solver *ego_, const problem *p_,
Chris@82: 		       const planner *plnr)
Chris@82: {
Chris@82:      const S *ego = (const S *) ego_;
Chris@82:      const problem_dft *p = (const problem_dft *) p_;
Chris@82:      return (1
Chris@82: 	     && FINITE_RNK(p->vecsz->rnk)
Chris@82: 
Chris@82: 	     /* problem must be a nontrivial transform, not just a copy */
Chris@82: 	     && p->sz->rnk > 0
Chris@82: 
Chris@82: 	     && (0
Chris@82: 
Chris@82: 		 /* problem must be in-place & require some
Chris@82: 		    rearrangement of the data; to prevent
Chris@82: 		    infinite loops with indirect-transpose, we
Chris@82: 		    further require that at least some transform
Chris@82: 		    strides must decrease */
Chris@82: 		 || (p->ri == p->ro
Chris@82: 		     && !X(tensor_inplace_strides2)(p->sz, p->vecsz)
Chris@82: 		     && X(tensor_strides_decrease)(
Chris@82: 			  p->sz, p->vecsz,
Chris@82: 			  ego->adt->apply == apply_after ? 
Chris@82: 			  INPLACE_IS : INPLACE_OS))
Chris@82: 
Chris@82: 		 /* or problem must be out of place, transforming
Chris@82: 		    from stride 1/2 to bigger stride, for apply_after */
Chris@82: 		 || (p->ri != p->ro && ego->adt->apply == apply_after
Chris@82: 		     && !NO_DESTROY_INPUTP(plnr)
Chris@82: 		     && X(tensor_min_istride)(p->sz) <= 2
Chris@82: 		     && X(tensor_min_ostride)(p->sz) > 2)
Chris@82: 			  
Chris@82: 		 /* or problem must be out of place, transforming
Chris@82: 		    to stride 1/2 from bigger stride, for apply_before */
Chris@82: 		 || (p->ri != p->ro && ego->adt->apply == apply_before
Chris@82: 		     && X(tensor_min_ostride)(p->sz) <= 2
Chris@82: 		     && X(tensor_min_istride)(p->sz) > 2)
Chris@82: 		  )
Chris@82: 	  );
Chris@82: }
Chris@82: 
Chris@82: static int applicable(const solver *ego_, const problem *p_,
Chris@82: 		      const planner *plnr)
Chris@82: {
Chris@82:      if (!applicable0(ego_, p_, plnr)) return 0;
Chris@82:      {
Chris@82:           const problem_dft *p = (const problem_dft *) p_;
Chris@82: 	  if (NO_INDIRECT_OP_P(plnr) && p->ri != p->ro) return 0;
Chris@82:      }
Chris@82:      return 1;
Chris@82: }
Chris@82: 
Chris@82: static plan *mkplan(const solver *ego_, const problem *p_, planner *plnr)
Chris@82: {
Chris@82:      const problem_dft *p = (const problem_dft *) p_;
Chris@82:      const S *ego = (const S *) ego_;
Chris@82:      P *pln;
Chris@82:      plan *cld = 0, *cldcpy = 0;
Chris@82: 
Chris@82:      static const plan_adt padt = {
Chris@82: 	  X(dft_solve), awake, print, destroy
Chris@82:      };
Chris@82: 
Chris@82:      if (!applicable(ego_, p_, plnr))
Chris@82:           return (plan *) 0;
Chris@82: 
Chris@82:      cldcpy =
Chris@82: 	  X(mkplan_d)(plnr, 
Chris@82: 		      X(mkproblem_dft_d)(X(mktensor_0d)(),
Chris@82: 					 X(tensor_append)(p->vecsz, p->sz),
Chris@82: 					 p->ri, p->ii, p->ro, p->io));
Chris@82: 
Chris@82:      if (!cldcpy) goto nada;
Chris@82: 
Chris@82:      cld = X(mkplan_f_d)(plnr, ego->adt->mkcld(p), NO_BUFFERING, 0, 0);
Chris@82:      if (!cld) goto nada;
Chris@82: 
Chris@82:      pln = MKPLAN_DFT(P, &padt, ego->adt->apply);
Chris@82:      pln->cld = cld;
Chris@82:      pln->cldcpy = cldcpy;
Chris@82:      pln->slv = ego;
Chris@82:      X(ops_add)(&cld->ops, &cldcpy->ops, &pln->super.super.ops);
Chris@82: 
Chris@82:      return &(pln->super.super);
Chris@82: 
Chris@82:  nada:
Chris@82:      X(plan_destroy_internal)(cld);
Chris@82:      X(plan_destroy_internal)(cldcpy);
Chris@82:      return (plan *)0;
Chris@82: }
Chris@82: 
Chris@82: static solver *mksolver(const ndrct_adt *adt)
Chris@82: {
Chris@82:      static const solver_adt sadt = { PROBLEM_DFT, mkplan, 0 };
Chris@82:      S *slv = MKSOLVER(S, &sadt);
Chris@82:      slv->adt = adt;
Chris@82:      return &(slv->super);
Chris@82: }
Chris@82: 
Chris@82: void X(dft_indirect_register)(planner *p)
Chris@82: {
Chris@82:      unsigned i;
Chris@82:      static const ndrct_adt *const adts[] = {
Chris@82: 	  &adt_before, &adt_after
Chris@82:      };
Chris@82: 
Chris@82:      for (i = 0; i < sizeof(adts) / sizeof(adts[0]); ++i)
Chris@82:           REGISTER_SOLVER(p, mksolver(adts[i]));
Chris@82: }