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: /* solvers/plans for vectors of DFTs corresponding to the columns
Chris@82:    of a matrix: first transpose the matrix so that the DFTs are
Chris@82:    contiguous, then do DFTs with transposed output.   In particular,
Chris@82:    we restrict ourselves to the case of a square transpose (or a
Chris@82:    sequence thereof). */
Chris@82: 
Chris@82: #include "dft/dft.h"
Chris@82: 
Chris@82: typedef solver S;
Chris@82: 
Chris@82: typedef struct {
Chris@82:      plan_dft super;
Chris@82:      INT vl, ivs, ovs;
Chris@82:      plan *cldtrans, *cld, *cldrest;
Chris@82: } P;
Chris@82: 
Chris@82: /* initial transpose is out-of-place from input to output */
Chris@82: static void apply_op(const plan *ego_, R *ri, R *ii, R *ro, R *io)
Chris@82: {
Chris@82:      const P *ego = (const P *) ego_;
Chris@82:      INT vl = ego->vl, ivs = ego->ivs, ovs = ego->ovs, i;
Chris@82: 
Chris@82:      for (i = 0; i < vl; ++i) {
Chris@82: 	  {
Chris@82: 	       plan_dft *cldtrans = (plan_dft *) ego->cldtrans;
Chris@82: 	       cldtrans->apply(ego->cldtrans, 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: 	  ri += ivs; ii += ivs;
Chris@82: 	  ro += ovs; io += ovs;
Chris@82:      }
Chris@82:      {
Chris@82: 	  plan_dft *cldrest = (plan_dft *) ego->cldrest;
Chris@82: 	  cldrest->apply(ego->cldrest, ri, ii, ro, io);
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->cldrest);
Chris@82:      X(plan_destroy_internal)(ego->cld);
Chris@82:      X(plan_destroy_internal)(ego->cldtrans);
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->cldtrans, wakefulness);
Chris@82:      X(plan_awake)(ego->cld, wakefulness);
Chris@82:      X(plan_awake)(ego->cldrest, 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:      p->print(p, "(indirect-transpose%v%(%p%)%(%p%)%(%p%))", 
Chris@82: 	      ego->vl, ego->cldtrans, ego->cld, ego->cldrest);
Chris@82: }
Chris@82: 
Chris@82: static int pickdim(const tensor *vs, const tensor *s, int *pdim0, int *pdim1)
Chris@82: {
Chris@82:      int dim0, dim1;
Chris@82:      *pdim0 = *pdim1 = -1;
Chris@82:      for (dim0 = 0; dim0 < vs->rnk; ++dim0)
Chris@82:           for (dim1 = 0; dim1 < s->rnk; ++dim1) 
Chris@82: 	       if (vs->dims[dim0].n * X(iabs)(vs->dims[dim0].is) <= X(iabs)(s->dims[dim1].is)
Chris@82: 		   && vs->dims[dim0].n >= s->dims[dim1].n
Chris@82: 		   && (*pdim0 == -1 
Chris@82: 		       || (X(iabs)(vs->dims[dim0].is) <= X(iabs)(vs->dims[*pdim0].is)
Chris@82: 			   && X(iabs)(s->dims[dim1].is) >= X(iabs)(s->dims[*pdim1].is)))) {
Chris@82: 		    *pdim0 = dim0;
Chris@82: 		    *pdim1 = dim1;
Chris@82: 	       }
Chris@82:      return (*pdim0 != -1 && *pdim1 != -1);
Chris@82: }
Chris@82: 
Chris@82: static int applicable0(const solver *ego_, const problem *p_,
Chris@82: 		       const planner *plnr,
Chris@82: 		       int *pdim0, int *pdim1)
Chris@82: {
Chris@82:      const problem_dft *p = (const problem_dft *) p_;
Chris@82:      UNUSED(ego_); UNUSED(plnr);
Chris@82: 
Chris@82:      return (1
Chris@82: 	     && FINITE_RNK(p->vecsz->rnk) && FINITE_RNK(p->sz->rnk)
Chris@82: 
Chris@82: 	     /* FIXME: can/should we relax this constraint? */
Chris@82: 	     && X(tensor_inplace_strides2)(p->vecsz, p->sz)
Chris@82: 
Chris@82: 	     && pickdim(p->vecsz, p->sz, pdim0, pdim1)
Chris@82: 
Chris@82: 	     /* output should not *already* include the transpose
Chris@82: 		(in which case we duplicate the regular indirect.c) */
Chris@82: 	     && (p->sz->dims[*pdim1].os != p->vecsz->dims[*pdim0].is)
Chris@82: 	  );
Chris@82: }
Chris@82: 
Chris@82: static int applicable(const solver *ego_, const problem *p_,
Chris@82: 		      const planner *plnr,
Chris@82: 		      int *pdim0, int *pdim1)
Chris@82: {
Chris@82:      if (!applicable0(ego_, p_, plnr, pdim0, pdim1)) return 0;
Chris@82:      {
Chris@82:           const problem_dft *p = (const problem_dft *) p_;
Chris@82: 	  INT u = p->ri == p->ii + 1 || p->ii == p->ri + 1 ? (INT)2 : (INT)1;
Chris@82: 
Chris@82: 	  /* UGLY if does not result in contiguous transforms or
Chris@82: 	     transforms of contiguous vectors (since the latter at
Chris@82: 	     least have efficient transpositions) */
Chris@82: 	  if (NO_UGLYP(plnr)
Chris@82: 	      && p->vecsz->dims[*pdim0].is != u
Chris@82: 	      && !(p->vecsz->rnk == 2
Chris@82: 		   && p->vecsz->dims[1-*pdim0].is == u
Chris@82: 		   && p->vecsz->dims[*pdim0].is
Chris@82: 		      == u * p->vecsz->dims[1-*pdim0].n))
Chris@82: 	       return 0;
Chris@82: 
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:      P *pln;
Chris@82:      plan *cld = 0, *cldtrans = 0, *cldrest = 0;
Chris@82:      int pdim0, pdim1;
Chris@82:      tensor *ts, *tv;
Chris@82:      INT vl, ivs, ovs;
Chris@82:      R *rit, *iit, *rot, *iot;
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, &pdim0, &pdim1))
Chris@82:           return (plan *) 0;
Chris@82: 
Chris@82:      vl = p->vecsz->dims[pdim0].n / p->sz->dims[pdim1].n;
Chris@82:      A(vl >= 1);
Chris@82:      ivs = p->sz->dims[pdim1].n * p->vecsz->dims[pdim0].is;
Chris@82:      ovs = p->sz->dims[pdim1].n * p->vecsz->dims[pdim0].os;
Chris@82:      rit = TAINT(p->ri, vl == 1 ? 0 : ivs);
Chris@82:      iit = TAINT(p->ii, vl == 1 ? 0 : ivs);
Chris@82:      rot = TAINT(p->ro, vl == 1 ? 0 : ovs);
Chris@82:      iot = TAINT(p->io, vl == 1 ? 0 : ovs);
Chris@82: 
Chris@82:      ts = X(tensor_copy_inplace)(p->sz, INPLACE_IS);
Chris@82:      ts->dims[pdim1].os = p->vecsz->dims[pdim0].is;
Chris@82:      tv = X(tensor_copy_inplace)(p->vecsz, INPLACE_IS);
Chris@82:      tv->dims[pdim0].os = p->sz->dims[pdim1].is;
Chris@82:      tv->dims[pdim0].n = p->sz->dims[pdim1].n;
Chris@82:      cldtrans = X(mkplan_d)(plnr, 
Chris@82: 			    X(mkproblem_dft_d)(X(mktensor_0d)(),
Chris@82: 					       X(tensor_append)(tv, ts),
Chris@82: 					       rit, iit, 
Chris@82: 					       rot, iot));
Chris@82:      X(tensor_destroy2)(ts, tv);
Chris@82:      if (!cldtrans) goto nada;
Chris@82: 
Chris@82:      ts = X(tensor_copy)(p->sz);
Chris@82:      ts->dims[pdim1].is = p->vecsz->dims[pdim0].is;
Chris@82:      tv = X(tensor_copy)(p->vecsz);
Chris@82:      tv->dims[pdim0].is = p->sz->dims[pdim1].is;
Chris@82:      tv->dims[pdim0].n = p->sz->dims[pdim1].n;
Chris@82:      cld = X(mkplan_d)(plnr, X(mkproblem_dft_d)(ts, tv,
Chris@82: 						rot, iot,
Chris@82: 						rot, iot));
Chris@82:      if (!cld) goto nada;
Chris@82: 
Chris@82:      tv = X(tensor_copy)(p->vecsz);
Chris@82:      tv->dims[pdim0].n -= vl * p->sz->dims[pdim1].n;
Chris@82:      cldrest = X(mkplan_d)(plnr, X(mkproblem_dft_d)(X(tensor_copy)(p->sz), tv,
Chris@82: 						    p->ri + ivs * vl,
Chris@82: 						    p->ii + ivs * vl,
Chris@82: 						    p->ro + ovs * vl,
Chris@82: 						    p->io + ovs * vl));
Chris@82:      if (!cldrest) goto nada;
Chris@82: 
Chris@82:      pln = MKPLAN_DFT(P, &padt, apply_op);
Chris@82:      pln->cldtrans = cldtrans;
Chris@82:      pln->cld = cld;
Chris@82:      pln->cldrest = cldrest;
Chris@82:      pln->vl = vl;
Chris@82:      pln->ivs = ivs;
Chris@82:      pln->ovs = ovs;
Chris@82:      X(ops_cpy)(&cldrest->ops, &pln->super.super.ops);
Chris@82:      X(ops_madd2)(vl, &cld->ops, &pln->super.super.ops);
Chris@82:      X(ops_madd2)(vl, &cldtrans->ops, &pln->super.super.ops);
Chris@82:      return &(pln->super.super);
Chris@82: 
Chris@82:  nada:
Chris@82:      X(plan_destroy_internal)(cldrest);
Chris@82:      X(plan_destroy_internal)(cld);
Chris@82:      X(plan_destroy_internal)(cldtrans);
Chris@82:      return (plan *)0;
Chris@82: }
Chris@82: 
Chris@82: static solver *mksolver(void)
Chris@82: {
Chris@82:      static const solver_adt sadt = { PROBLEM_DFT, mkplan, 0 };
Chris@82:      S *slv = MKSOLVER(S, &sadt);
Chris@82:      return slv;
Chris@82: }
Chris@82: 
Chris@82: void X(dft_indirect_transpose_register)(planner *p)
Chris@82: {
Chris@82:      REGISTER_SOLVER(p, mksolver());
Chris@82: }