The R Project SVN R-packages

Rev

Rev 4371 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4371 Rev 4501
Line -... Line 1...
- 
 
 1 
%%----- Docu for *all* sparse vector classes ----------
1 
\name{sparseVector-class}
 2 
\name{sparseVector-class}
2 
\docType{class}
 3 
\docType{class}
3 
\title{Sparse Vector Classes}
 4 
\title{Sparse Vector Classes}
4 
\alias{sparseVector-class}
 5 
\alias{sparseVector-class}
5 
% sub classes
 6 
% sub classes
6 
\alias{dsparseVector-class}
 7 
\alias{dsparseVector-class}
7 
\alias{isparseVector-class}
 8 
\alias{isparseVector-class}
8 
\alias{lsparseVector-class}
 9 
\alias{lsparseVector-class}
9 
\alias{nsparseVector-class}
 10 
\alias{nsparseVector-class}
10 
\alias{zsparseVector-class}
 11 
\alias{zsparseVector-class}
- 
 
 12 
\alias{xsparseVector-class}% the class union
11 
%% Group methods
 13 
%% Group methods
12 
% \alias{Math,sparseVector-method}
 14 
% \alias{Math,sparseVector-method}
13 
% %\alias{Math2,sparseVector,numeric-method}
 15 
% %\alias{Math2,sparseVector,numeric-method}
14 
\alias{Arith,sparseVector,sparseVector-method}
 16 
\alias{Arith,sparseVector,sparseVector-method}
15 
\alias{Arith,dsparseVector,dsparseVector-method}
 17 
\alias{Arith,dsparseVector,dsparseVector-method}
Line 26... Line 28...
26 
\alias{coerce,diagonalMatrix,sparseVector-method}
 28 
\alias{coerce,diagonalMatrix,sparseVector-method}
27 
\alias{coerce,sparseMatrix,sparseVector-method}
 29 
\alias{coerce,sparseMatrix,sparseVector-method}
28 
\alias{coerce,atomicVector,sparseVector-method}
 30 
\alias{coerce,atomicVector,sparseVector-method}
29 
\alias{coerce,triangularVector,sparseVector-method}
 31 
\alias{coerce,triangularVector,sparseVector-method}
30 
\alias{coerce,sparseVector,vector-method}
 32 
\alias{coerce,sparseVector,vector-method}
- 
 
 33 
\alias{coerce,xsparseVector,dsparseVector-method}
- 
 
 34 
\alias{coerce,xsparseVector,isparseVector-method}
- 
 
 35 
\alias{coerce,xsparseVector,lsparseVector-method}
- 
 
 36 
\alias{coerce,xsparseVector,zsparseVector-method}
- 
 
 37 
\alias{coerce,sparseVector,nsparseVector-method}
- 
 
 38 
%
31 
\alias{as.numeric,sparseVector-method}
 39 
\alias{as.numeric,sparseVector-method}
32 
\alias{as.vector,sparseVector,missing-method}
 40 
\alias{as.vector,sparseVector,missing-method}
33 
\alias{as.vector,sparseVector,character-method}
 41 
\alias{as.vector,sparseVector,character-method}
34 
\alias{length,sparseVector-method}
 42 
\alias{length,sparseVector-method}
35 
\alias{show,sparseVector-method}
 43 
\alias{show,sparseVector-method}
Line 54... Line 62...
54 
      the non-zero entries.  This is of class \code{"numeric"} for class
 62 
      the non-zero entries.  This is of class \code{"numeric"} for class
55 
      \code{"dsparseVector"},  \code{"logical"} for class
 63 
      \code{"dsparseVector"},  \code{"logical"} for class
56 
      \code{"lsparseVector"}, etc.
 64 
      \code{"lsparseVector"}, etc.
57 
 
 65 
 
58 
      Note that \code{"nsparseVector"}s have no \code{x} slot.
 66 
      Note that \code{"nsparseVector"}s have no \code{x} slot.
- 
 
 67 
      Further, mainly for ease of method definitions, we've defined the
- 
 
 68 
      class union (see \code{\link{setClassUnion}}) of all sparse vector
- 
 
 69 
      classes which \emph{have} an \code{x} slot, as class \code{"xsparseVector"}.
59 
      }
 70 
      }
60 
  }
 71 
  }
61 
}
 72 
}
62 
\section{Methods}{
 73 
\section{Methods}{
63 
  \describe{
 74 
  \describe{
Line 79... Line 90...
79 
}
 90 
}
80 
%\author{Martin}
 91 
%\author{Martin}
81 
\examples{
 92 
\examples{
82 
showClass("sparseVector")
 93 
showClass("sparseVector")
83 
showClass("dsparseVector")
 94 
showClass("dsparseVector")
- 
 
 95 
showClass("xsparseVector")# those with an 'x' slot
84 
 
 96 
 
85 
sx <- c(0,0,3, 3.2, 0,0,0,-3:1,0,0,2,0,0,5,0,0)
 97 
sx <- c(0,0,3, 3.2, 0,0,0,-3:1,0,0,2,0,0,5,0,0)
86 
(ss <- as(sx, "sparseVector"))
 98 
(ss <- as(sx, "sparseVector"))
87 
 
 99 
 
- 
 
 100 
ix <- as.integer(round(sx))
- 
 
 101 
(is <- as(ix, "sparseVector"))
- 
 
 102 
%% FIXME: I'd want  isparseVector
- 
 
 103 
%%
- 
 
 104 
as(is, "isparseVector") %% ERROR ## FIXME
- 
 
 105 
 
88 
%% FIXME: Explain and show  spV2M() or its successor
 106 
%% FIXME: Explain and show  spV2M() or its successor
89 
 
 107 
 
- 
 
 108 
 
90 
}
 109 
}
91 
\keyword{classes}
 110 
\keyword{classes}