cannam@127: /*
cannam@127:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@127:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@127:  *
cannam@127:  * This program is free software; you can redistribute it and/or modify
cannam@127:  * it under the terms of the GNU General Public License as published by
cannam@127:  * the Free Software Foundation; either version 2 of the License, or
cannam@127:  * (at your option) any later version.
cannam@127:  *
cannam@127:  * This program is distributed in the hope that it will be useful,
cannam@127:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@127:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@127:  * GNU General Public License for more details.
cannam@127:  *
cannam@127:  * You should have received a copy of the GNU General Public License
cannam@127:  * along with this program; if not, write to the Free Software
cannam@127:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@127:  *
cannam@127:  */
cannam@127: 
cannam@127: /* solvers/plans for vectors of DFTs corresponding to the columns
cannam@127:    of a matrix: first transpose the matrix so that the DFTs are
cannam@127:    contiguous, then do DFTs with transposed output.   In particular,
cannam@127:    we restrict ourselves to the case of a square transpose (or a
cannam@127:    sequence thereof). */
cannam@127: 
cannam@127: #include "dft.h"
cannam@127: 
cannam@127: typedef solver S;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      plan_dft super;
cannam@127:      INT vl, ivs, ovs;
cannam@127:      plan *cldtrans, *cld, *cldrest;
cannam@127: } P;
cannam@127: 
cannam@127: /* initial transpose is out-of-place from input to output */
cannam@127: static void apply_op(const plan *ego_, R *ri, R *ii, R *ro, R *io)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      INT vl = ego->vl, ivs = ego->ivs, ovs = ego->ovs, i;
cannam@127: 
cannam@127:      for (i = 0; i < vl; ++i) {
cannam@127: 	  {
cannam@127: 	       plan_dft *cldtrans = (plan_dft *) ego->cldtrans;
cannam@127: 	       cldtrans->apply(ego->cldtrans, ri, ii, ro, io);
cannam@127: 	  }
cannam@127: 	  {
cannam@127: 	       plan_dft *cld = (plan_dft *) ego->cld;
cannam@127: 	       cld->apply(ego->cld, ro, io, ro, io);
cannam@127: 	  }
cannam@127: 	  ri += ivs; ii += ivs;
cannam@127: 	  ro += ovs; io += ovs;
cannam@127:      }
cannam@127:      {
cannam@127: 	  plan_dft *cldrest = (plan_dft *) ego->cldrest;
cannam@127: 	  cldrest->apply(ego->cldrest, ri, ii, ro, io);
cannam@127:      }
cannam@127: }
cannam@127: 
cannam@127: static void destroy(plan *ego_)
cannam@127: {
cannam@127:      P *ego = (P *) ego_;
cannam@127:      X(plan_destroy_internal)(ego->cldrest);
cannam@127:      X(plan_destroy_internal)(ego->cld);
cannam@127:      X(plan_destroy_internal)(ego->cldtrans);
cannam@127: }
cannam@127: 
cannam@127: static void awake(plan *ego_, enum wakefulness wakefulness)
cannam@127: {
cannam@127:      P *ego = (P *) ego_;
cannam@127:      X(plan_awake)(ego->cldtrans, wakefulness);
cannam@127:      X(plan_awake)(ego->cld, wakefulness);
cannam@127:      X(plan_awake)(ego->cldrest, wakefulness);
cannam@127: }
cannam@127: 
cannam@127: static void print(const plan *ego_, printer *p)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      p->print(p, "(indirect-transpose%v%(%p%)%(%p%)%(%p%))", 
cannam@127: 	      ego->vl, ego->cldtrans, ego->cld, ego->cldrest);
cannam@127: }
cannam@127: 
cannam@127: static int pickdim(const tensor *vs, const tensor *s, int *pdim0, int *pdim1)
cannam@127: {
cannam@127:      int dim0, dim1;
cannam@127:      *pdim0 = *pdim1 = -1;
cannam@127:      for (dim0 = 0; dim0 < vs->rnk; ++dim0)
cannam@127:           for (dim1 = 0; dim1 < s->rnk; ++dim1) 
cannam@127: 	       if (vs->dims[dim0].n * X(iabs)(vs->dims[dim0].is) <= X(iabs)(s->dims[dim1].is)
cannam@127: 		   && vs->dims[dim0].n >= s->dims[dim1].n
cannam@127: 		   && (*pdim0 == -1 
cannam@127: 		       || (X(iabs)(vs->dims[dim0].is) <= X(iabs)(vs->dims[*pdim0].is)
cannam@127: 			   && X(iabs)(s->dims[dim1].is) >= X(iabs)(s->dims[*pdim1].is)))) {
cannam@127: 		    *pdim0 = dim0;
cannam@127: 		    *pdim1 = dim1;
cannam@127: 	       }
cannam@127:      return (*pdim0 != -1 && *pdim1 != -1);
cannam@127: }
cannam@127: 
cannam@127: static int applicable0(const solver *ego_, const problem *p_,
cannam@127: 		       const planner *plnr,
cannam@127: 		       int *pdim0, int *pdim1)
cannam@127: {
cannam@127:      const problem_dft *p = (const problem_dft *) p_;
cannam@127:      UNUSED(ego_); UNUSED(plnr);
cannam@127: 
cannam@127:      return (1
cannam@127: 	     && FINITE_RNK(p->vecsz->rnk) && FINITE_RNK(p->sz->rnk)
cannam@127: 
cannam@127: 	     /* FIXME: can/should we relax this constraint? */
cannam@127: 	     && X(tensor_inplace_strides2)(p->vecsz, p->sz)
cannam@127: 
cannam@127: 	     && pickdim(p->vecsz, p->sz, pdim0, pdim1)
cannam@127: 
cannam@127: 	     /* output should not *already* include the transpose
cannam@127: 		(in which case we duplicate the regular indirect.c) */
cannam@127: 	     && (p->sz->dims[*pdim1].os != p->vecsz->dims[*pdim0].is)
cannam@127: 	  );
cannam@127: }
cannam@127: 
cannam@127: static int applicable(const solver *ego_, const problem *p_,
cannam@127: 		      const planner *plnr,
cannam@127: 		      int *pdim0, int *pdim1)
cannam@127: {
cannam@127:      if (!applicable0(ego_, p_, plnr, pdim0, pdim1)) return 0;
cannam@127:      {
cannam@127:           const problem_dft *p = (const problem_dft *) p_;
cannam@127: 	  INT u = p->ri == p->ii + 1 || p->ii == p->ri + 1 ? (INT)2 : (INT)1;
cannam@127: 
cannam@127: 	  /* UGLY if does not result in contiguous transforms or
cannam@127: 	     transforms of contiguous vectors (since the latter at
cannam@127: 	     least have efficient transpositions) */
cannam@127: 	  if (NO_UGLYP(plnr)
cannam@127: 	      && p->vecsz->dims[*pdim0].is != u
cannam@127: 	      && !(p->vecsz->rnk == 2
cannam@127: 		   && p->vecsz->dims[1-*pdim0].is == u
cannam@127: 		   && p->vecsz->dims[*pdim0].is
cannam@127: 		      == u * p->vecsz->dims[1-*pdim0].n))
cannam@127: 	       return 0;
cannam@127: 
cannam@127: 	  if (NO_INDIRECT_OP_P(plnr) && p->ri != p->ro) return 0;
cannam@127:      }
cannam@127:      return 1;
cannam@127: }
cannam@127: 
cannam@127: static plan *mkplan(const solver *ego_, const problem *p_, planner *plnr)
cannam@127: {
cannam@127:      const problem_dft *p = (const problem_dft *) p_;
cannam@127:      P *pln;
cannam@127:      plan *cld = 0, *cldtrans = 0, *cldrest = 0;
cannam@127:      int pdim0, pdim1;
cannam@127:      tensor *ts, *tv;
cannam@127:      INT vl, ivs, ovs;
cannam@127:      R *rit, *iit, *rot, *iot;
cannam@127: 
cannam@127:      static const plan_adt padt = {
cannam@127: 	  X(dft_solve), awake, print, destroy
cannam@127:      };
cannam@127: 
cannam@127:      if (!applicable(ego_, p_, plnr, &pdim0, &pdim1))
cannam@127:           return (plan *) 0;
cannam@127: 
cannam@127:      vl = p->vecsz->dims[pdim0].n / p->sz->dims[pdim1].n;
cannam@127:      A(vl >= 1);
cannam@127:      ivs = p->sz->dims[pdim1].n * p->vecsz->dims[pdim0].is;
cannam@127:      ovs = p->sz->dims[pdim1].n * p->vecsz->dims[pdim0].os;
cannam@127:      rit = TAINT(p->ri, vl == 1 ? 0 : ivs);
cannam@127:      iit = TAINT(p->ii, vl == 1 ? 0 : ivs);
cannam@127:      rot = TAINT(p->ro, vl == 1 ? 0 : ovs);
cannam@127:      iot = TAINT(p->io, vl == 1 ? 0 : ovs);
cannam@127: 
cannam@127:      ts = X(tensor_copy_inplace)(p->sz, INPLACE_IS);
cannam@127:      ts->dims[pdim1].os = p->vecsz->dims[pdim0].is;
cannam@127:      tv = X(tensor_copy_inplace)(p->vecsz, INPLACE_IS);
cannam@127:      tv->dims[pdim0].os = p->sz->dims[pdim1].is;
cannam@127:      tv->dims[pdim0].n = p->sz->dims[pdim1].n;
cannam@127:      cldtrans = X(mkplan_d)(plnr, 
cannam@127: 			    X(mkproblem_dft_d)(X(mktensor_0d)(),
cannam@127: 					       X(tensor_append)(tv, ts),
cannam@127: 					       rit, iit, 
cannam@127: 					       rot, iot));
cannam@127:      X(tensor_destroy2)(ts, tv);
cannam@127:      if (!cldtrans) goto nada;
cannam@127: 
cannam@127:      ts = X(tensor_copy)(p->sz);
cannam@127:      ts->dims[pdim1].is = p->vecsz->dims[pdim0].is;
cannam@127:      tv = X(tensor_copy)(p->vecsz);
cannam@127:      tv->dims[pdim0].is = p->sz->dims[pdim1].is;
cannam@127:      tv->dims[pdim0].n = p->sz->dims[pdim1].n;
cannam@127:      cld = X(mkplan_d)(plnr, X(mkproblem_dft_d)(ts, tv,
cannam@127: 						rot, iot,
cannam@127: 						rot, iot));
cannam@127:      if (!cld) goto nada;
cannam@127: 
cannam@127:      tv = X(tensor_copy)(p->vecsz);
cannam@127:      tv->dims[pdim0].n -= vl * p->sz->dims[pdim1].n;
cannam@127:      cldrest = X(mkplan_d)(plnr, X(mkproblem_dft_d)(X(tensor_copy)(p->sz), tv,
cannam@127: 						    p->ri + ivs * vl,
cannam@127: 						    p->ii + ivs * vl,
cannam@127: 						    p->ro + ovs * vl,
cannam@127: 						    p->io + ovs * vl));
cannam@127:      if (!cldrest) goto nada;
cannam@127: 
cannam@127:      pln = MKPLAN_DFT(P, &padt, apply_op);
cannam@127:      pln->cldtrans = cldtrans;
cannam@127:      pln->cld = cld;
cannam@127:      pln->cldrest = cldrest;
cannam@127:      pln->vl = vl;
cannam@127:      pln->ivs = ivs;
cannam@127:      pln->ovs = ovs;
cannam@127:      X(ops_cpy)(&cldrest->ops, &pln->super.super.ops);
cannam@127:      X(ops_madd2)(vl, &cld->ops, &pln->super.super.ops);
cannam@127:      X(ops_madd2)(vl, &cldtrans->ops, &pln->super.super.ops);
cannam@127:      return &(pln->super.super);
cannam@127: 
cannam@127:  nada:
cannam@127:      X(plan_destroy_internal)(cldrest);
cannam@127:      X(plan_destroy_internal)(cld);
cannam@127:      X(plan_destroy_internal)(cldtrans);
cannam@127:      return (plan *)0;
cannam@127: }
cannam@127: 
cannam@127: static solver *mksolver(void)
cannam@127: {
cannam@127:      static const solver_adt sadt = { PROBLEM_DFT, mkplan, 0 };
cannam@127:      S *slv = MKSOLVER(S, &sadt);
cannam@127:      return slv;
cannam@127: }
cannam@127: 
cannam@127: void X(dft_indirect_transpose_register)(planner *p)
cannam@127: {
cannam@127:      REGISTER_SOLVER(p, mksolver());
cannam@127: }