用jCUDA对复矩阵进行运算

Question

使用JCUDA对复数进行运算的最佳方法是什么？我应该使用cuComplex格式还是有其他的解决方案（像一个数组，实部和虚部一个接着一个走）？我非常感谢使用这种类型的计算的java代码示例。

由于我的目的是用GPU求解复杂的线性方程组，所以我不想只附上jCuda。用GPU进行这样的计算有哪些可供选择的方式？

Answer 1

首先，关于您关于在GPU上使用Java进行计算的问题，我在这里写了几句话。

你的申请案例似乎很具体。您可能应该更详细地描述您的实际意图是什么，因为这将支配所有的设计决策。到现在为止，我只能给出一些基本的提示。决定哪一个是最合适的解决方案是由您自己决定的。

在Java世界和GPU世界之间架桥时的一个主要困难是根本不同的内存处理。

CUDA中的CUComplex结构定义为

typedef float2 cuFloatComplex
typedef cuFloatComplex cuComplex;

其中float2基本上类似于

struct float2 {
    float x; 
    float y; 
};

（带有一些用于对齐等的附加说明符）

现在，当您在C/C++程序中分配CUComplex值的数组时，您只需编写如下内容

cuComplex *c = new cuComplex[100];

在这种情况下，可以保证所有这些CuComplex值的内存将是一个单一的、连续的内存块。此内存块仅由复数的所有x和y值组成，这些值一个接一个：

      _____________________________
c -> | x0 | y0 | x1 | y1 | x2 | y2 |... 
     |____|____|____|____|____|____|

这个连续的内存块可以很容易地复制到设备：一个获取指针，并调用类似于

cudaMemcpy(device, c, sizeof(cuComplex)*n, cudaMemcpyHostToDevice);

考虑以下情况：创建一个结构上等于CUComplex结构的Java类，并分配一个数组：

 class cuComplex {
     public float x;
     public float y;
 }

 cuComplex c[] = new cuComplex[100];

则没有float值的单个连续内存块。相反，您有一个数组对CUComplex对象的引用，相应的x和y值分散在周围：

      ____________________
c -> |  c0  |  c1  |  c2  |... 
     |______|______|______|
        |       |      |
        v       v      v
      [x,y]   [x,y]  [x,y]

这里的重点是：

不能将CuComplex对象的(Java)数组复制到设备！

这有几个含义。在注释中，您已经提到了CublassetVector方法，该方法将CUComplex数组作为参数，我试图强调这不是最有效的解决方案，只是为了方便。实际上，此方法的工作方式是在内部创建一个新的ByteBuffer，以便拥有一个连续的内存块，然后用CUComplex[]数组中的值填充此ByteBuffer，然后将此ByteBuffer复制到设备。

当然，这会带来一个开销，而在性能关键的应用程序中，您很可能希望避免这种开销。

解决这个问题有几种选择。幸运的是,对于复数,解决方法比较简单：

不要使用cucomplex结构来表示复数的数组

如果我们试图将其泛化，不仅指复数，而且指一般的“结构”，那么就有一种“模式”可以应用：我们可以为结构创建接口，并创建这些结构的集合，该集合是实现该接口的类的实例列表，所有这些实例都由一个连续的内存块支持。这可能适用于某些情况。但是对于复数，为每个复数设置一个Java对象的内存开销可能会大得吓人。

另一个极端，仅处理原始的float[]或double[]数组也可能不是最佳解决方案。例如：如果您有一个数组表示复数的float值，那么如何将其中一个复数与另一个复数相乘呢？

一个“中间”解决方案可以创建一个接口，允许访问复数的实部和虚部。在实现中，这些复数存储在单个数组中，如上所述。

我在这里勾画了这样一个实现。

这只是作为一个示例，展示基本思想，并展示它如何与jCublas这样的东西协同工作。对您来说，一个不同的策略可能更合适，这取决于您的实际目标：应该有哪些其他后端（除了JCuda）？在Java端处理复数应该有多“方便”？在Java端处理复数的结构（类/接口）应该是什么样子的？

简而言之：在继续实现之前，您应该对您的应用程序/库应该能够做什么有一个非常清楚的想法。

import static jcuda.jcublas.JCublas2.*;
import static jcuda.jcublas.cublasOperation.CUBLAS_OP_N;
import static jcuda.runtime.JCuda.*;

import java.util.Random;

import jcuda.*;
import jcuda.jcublas.cublasHandle;
import jcuda.runtime.cudaMemcpyKind;

// An interface describing an array of complex numbers, residing
// on the host, with methods for accessing the real and imaginary
// parts of the complex numbers, as well as methods for copying
// the underlying data from and to the device
interface cuComplexHostArray
{
    int size();

    float getReal(int i);
    float getImag(int i);

    void setReal(int i, float real);
    void setImag(int i, float imag);

    void set(int i, cuComplex c);
    void set(int i, float real, float imag);

    cuComplex get(int i, cuComplex c);

    void copyToDevice(Pointer devicePointer);
    void copyFromDevice(Pointer devicePointer);
}

// A default implementathtml" target="_blank">ion of a cuComplexHostArray, backed
// by a single float[] array
class DefaultCuComplexHostArray implements cuComplexHostArray
{
    private final int size;
    private final float data[];

    DefaultCuComplexHostArray(int size)
    {
        this.size = size;
        this.data = new float[size * 2];
    }

    @Override
    public int size()
    {
        return size;
    }

    @Override
    public float getReal(int i)
    {
        return data[i+i];
    }

    @Override
    public float getImag(int i)
    {
        return data[i+i+1];
    }

    @Override
    public void setReal(int i, float real)
    {
        data[i+i] = real;
    }

    @Override
    public void setImag(int i, float imag)
    {
        data[i+i+1] = imag;
    }

    @Override
    public void set(int i, cuComplex c)
    {
        data[i+i+0] = c.x;
        data[i+i+1] = c.y;
    }

    @Override
    public void set(int i, float real, float imag)
    {
        data[i+i+0] = real;
        data[i+i+1] = imag;
    }

    @Override
    public cuComplex get(int i, cuComplex c)
    {
        float real = getReal(i);
        float imag = getImag(i);
        if (c != null)
        {
            c.x = real;
            c.y = imag;
            return c;
        }
        return cuComplex.cuCmplx(real, imag);
    }

    @Override
    public void copyToDevice(Pointer devicePointer)
    {
        cudaMemcpy(devicePointer, Pointer.to(data),
            size * Sizeof.FLOAT * 2,
            cudaMemcpyKind.cudaMemcpyHostToDevice);
    }

    @Override
    public void copyFromDevice(Pointer devicePointer)
    {
        cudaMemcpy(Pointer.to(data), devicePointer,
            size * Sizeof.FLOAT * 2,
            cudaMemcpyKind.cudaMemcpyDeviceToHost);
    }
}

// An example that performs a "gemm" with complex numbers, once
// in Java and once in JCublas2, and verifies the result
public class JCublas2ComplexSample
{
    public static void main(String args[])
    {
        testCgemm(500);
    }

    public static void testCgemm(int n)
    {
        cuComplex alpha = cuComplex.cuCmplx(0.3f, 0.2f);
        cuComplex beta  = cuComplex.cuCmplx(0.1f, 0.7f);
        int nn = n * n;

        System.out.println("Creating input data...");
        Random random = new Random(0);
        cuComplex[] rhA = createRandomComplexRawArray(nn, random);
        cuComplex[] rhB = createRandomComplexRawArray(nn, random);
        cuComplex[] rhC = createRandomComplexRawArray(nn, random);

        random = new Random(0);
        cuComplexHostArray hA = createRandomComplexHostArray(nn, random);
        cuComplexHostArray hB = createRandomComplexHostArray(nn, random);
        cuComplexHostArray hC = createRandomComplexHostArray(nn, random);

        System.out.println("Performing Cgemm with Java...");
        cgemmJava(n, alpha, rhA, rhB, beta, rhC);

        System.out.println("Performing Cgemm with JCublas...");
        cgemmJCublas(n, alpha, hA, hB, beta, hC);

        boolean passed = isCorrectResult(hC, rhC);
        System.out.println("testCgemm "+(passed?"PASSED":"FAILED"));
    }

    private static void cgemmJCublas(
        int n,
        cuComplex alpha,
        cuComplexHostArray A,
        cuComplexHostArray B,
        cuComplex beta,
        cuComplexHostArray C)
    {
        int nn = n * n;

        // Create a CUBLAS handle
        cublasHandle handle = new cublasHandle();
        cublasCreate(handle);

        // Allocate memory on the device
        Pointer dA = new Pointer();
        Pointer dB = new Pointer();
        Pointer dC = new Pointer();
        cudaMalloc(dA, nn * Sizeof.FLOAT * 2);
        cudaMalloc(dB, nn * Sizeof.FLOAT * 2);
        cudaMalloc(dC, nn * Sizeof.FLOAT * 2);

        // Copy the memory from the host to the device
        A.copyToDevice(dA);
        B.copyToDevice(dB);
        C.copyToDevice(dC);

        // Execute cgemm
        Pointer pAlpha = Pointer.to(new float[]{alpha.x, alpha.y});
        Pointer pBeta = Pointer.to(new float[]{beta.x, beta.y});
        cublasCgemm(handle, CUBLAS_OP_N, CUBLAS_OP_N, n, n, n,
            pAlpha, dA, n, dB, n, pBeta, dC, n);

        // Copy the result from the device to the host
        C.copyFromDevice(dC);

        // Clean up
        cudaFree(dA);
        cudaFree(dB);
        cudaFree(dC);
        cublasDestroy(handle);
    }

    private static void cgemmJava(
        int n,
        cuComplex alpha,
        cuComplex A[],
        cuComplex B[],
        cuComplex beta,
        cuComplex C[])
    {
        for (int i = 0; i < n; ++i)
        {
            for (int j = 0; j < n; ++j)
            {
                cuComplex prod = cuComplex.cuCmplx(0, 0);
                for (int k = 0; k < n; ++k)
                {
                    cuComplex ab =
                        cuComplex.cuCmul(A[k * n + i], B[j * n + k]);
                    prod = cuComplex.cuCadd(prod, ab);
                }
                cuComplex ap = cuComplex.cuCmul(alpha, prod);
                cuComplex bc = cuComplex.cuCmul(beta, C[j * n + i]);
                C[j * n + i] = cuComplex.cuCadd(ap, bc);
            }
        }
    }

    private static cuComplex[] createRandomComplexRawArray(
        int n, Random random)
    {
        cuComplex c[] = new cuComplex[n];
        for (int i = 0; i < n; i++)
        {
            float real = random.nextFloat();
            float imag = random.nextFloat();
            c[i] = cuComplex.cuCmplx(real, imag);
        }
        return c;
    }

    private static cuComplexHostArray createRandomComplexHostArray(
        int n, Random random)
    {
        cuComplexHostArray c = new DefaultCuComplexHostArray(n);
        for (int i = 0; i < n; i++)
        {
            float real = random.nextFloat();
            float imag = random.nextFloat();
            c.setReal(i, real);
            c.setImag(i, imag);
        }
        return c;
    }

    private static boolean isCorrectResult(
        cuComplexHostArray result, cuComplex reference[])
    {
        float errorNormX = 0;
        float errorNormY = 0;
        float refNormX = 0;
        float refNormY = 0;
        for (int i = 0; i < result.size(); i++)
        {
            float diffX = reference[i].x - result.getReal(i);
            float diffY = reference[i].y - result.getImag(i);
            errorNormX += diffX * diffX;
            errorNormY += diffY * diffY;
            refNormX += reference[i].x * result.getReal(i);
            refNormY += reference[i].y * result.getImag(i);
        }
        errorNormX = (float) Math.sqrt(errorNormX);
        errorNormY = (float) Math.sqrt(errorNormY);
        refNormX = (float) Math.sqrt(refNormX);
        refNormY = (float) Math.sqrt(refNormY);
        if (Math.abs(refNormX) < 1e-6)
        {
            return false;
        }
        if (Math.abs(refNormY) < 1e-6)
        {
            return false;
        }
        return
            (errorNormX / refNormX < 1e-6f) &&
            (errorNormY / refNormY < 1e-6f);
    }
}

（顺便说一句：我可能会将这个答案的一部分进行扩展，使之成为JCUDA的示例和/或“如何...”页面。提供类似这样的信息的任务已经在我的“待办事项”列表上很久了）。